bigbank/digidoc

Library to interface with the Estonian national identification platform (DigiDocService)

PHP Library for Estonian Digital ID (DigiDocService)

, _(*1)

This is a PHP library for communicating with the Certification Centre's DigiDocService API. The API is SOAP-based, documentation is available here., _(*2)

Install

Via Composer, _(*3)

``` bash $ composer require bigbank/digidoc, <sub>(*4)</sub>

The library requires PHP `>=5.6`, `curl`, `soap`, `xml`, `mbstring` and `openssl` extensions.

## Usage

``` php
// Instantiate the main class
$digiDoc = new DigiDoc(DigiDoc::URL_TEST);

// Ask for a service (see: Services)
/** @var AuthenticatorInterface $authenticator */
$authenticator = $digiDoc->getService(AuthenticatorInterface::class);

// Start mobile ID authentication
$userDetails = $authenticator->authenticate('14212128025', '+37200007', 'Testimine', 'My Test App', false);

// Wait for the user to complete the process
$authenticator->waitForAuthentication(function ($authResult) {
 return $authResult === 'USER_AUTHENTICATED' ? 'welcome!' : 'not authenticated';
});

More detailed usage examples are provided in the examples directory., <sub>(*5)</sub>

To use a HTTP proxy, set HTTP_PROXY environment variable., <sub>(*6)</sub>

Services

The library provides access to the following services:, <sub>(*7)</sub>

Authentication With Mobile ID

Authenticate the user with his mobile ID., <sub>(*8)</sub>

• Interface Name: AuthenticatorInterface
• DigiDocService: 7. Queries and Responses for Authentication / 7.1 MobileAuthenticate

Usage

See examples/mobile/authentication.php., <sub>(*9)</sub>

Digital Signature With Mobile ID

Allow users to digitally sign files using mobile ID., <sub>(*10)</sub>

• Interface Name: FileSignerInterface
• DigiDocService: 8. Queries and Responses for Digital Signature

Usage

See examples/mobile/signing.php., <sub>(*11)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*12)</sub>

Testing

bash $ composer test, <sub>(*13)</sub>

Known Issues

• Challenge verification is not done for authentication queries (see Challenge and SPChallenge parameters for MobileAuthenticate query). This is planned in future versions.

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*14)</sub>

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker., <sub>(*15)</sub>

Credits

• Bigbank's developers
• All Contributors

License

The Apache 2 License. Please see License File for more information., <sub>(*16)</sub>