Attestation and Metadata Statement
Disclaimer: you should not ask for the Attestation Statement unless you are working on an application that requires a high level of trust (e.g. Banking/Financial Company, Government Agency...).

Attestation Statement

During the Attestation Ceremony (i.e. the registration of the authenticator), you can ask for the Attestation Statement of the authenticator. The Attestation Statements have one of the following types:
  • None (none): no Attestation Statement is provided
  • Basic Attestation (basic): Authenticator’s attestation key pair is specific to an authenticator model.
  • Surrogate Basic Attestation (or Self Attestation - self): Authenticators that have no specific attestation key use the credential private key to create the attestation signature
  • Attestation CA (AttCA): Authenticators are based on a Trusted Platform Module (TPM). They can generate multiple attestation identity key pairs (AIK) and requests an Attestation CA to issue an AIK certificate for each.
  • Anonymization CA (AnonCA): Authenticators use an Anonymization CA, which dynamically generates per-credential attestation certificates such that the attestation statements presented to Relying Parties do not provide uniquely identifiable information.
  • Elliptic Curve based Direct Anonymous Attestation (ECDAA): Authenticator receives direct anonymous attestation (DAA) credentials from a single DAA-Issuer. These DAA credentials are used along with blinding to sign the attested credential data.

Metadata Statement

The Metadata Statements are issued by the manufacturers of the authenticators. These statements contain details about the authenticators (supported algorithms, biometric capabilities...) and all the necessary information to verify the Attestation Statements generated during the attestation ceremony.
There are several possible sources to get these Metadata Statements. The main source is the FIDO Alliance Metadata Service that allows fetching statements on-demand, but some of them may be provided by other means.
The FIDO Alliance Metadata Service provides a limited number of Metadata Statements. It is mandatory to get the statement from the manufacturer of your authenticators otherwise the Attestation Statement won't be verified and the Attestation Ceremony will fail.

Receiving Attestation Statement

Attestation Metadata Repository

First of all, you must prepare an Attestation Metadata Repository. This service will manage all Metadata Statements depending on their sources (local storage or distant service).
Your Metadata Statement Repository must implement the interface Webauthn\MetadataService\MetadataStatementRepository that has two methods:
  • findOneByAAGUID(string $aaguid): this method retrieves the MetadataStatement object with AAGUID. It shall return null in case of the absence of the MDS.
  • findStatusReportsByAAGUID(string $aaguid): retrieves all StatusReport objects. These objects show the MDS compliance history.
The library does not provide any Metadata Statement Repositroy. It is up to you to select the MDS suitable for your application and store them in your database.

The Easy Way

You just have to inject the Metadata Statement Repository to your Server class.
1
<?php
2
3
use Webauthn\Server;
4
use Webauthn\PublicKeyCredentialRpEntity;
5
6
...
7
8
// Before v3.3
9
$server = new Server(
10
$rpEntity,
11
$publicKeyCredentialSourceRepository,
12
$myMetadataStatementRepository // Inject your new service here
13
);
14
15
// Or v3.3+
16
$server = new Server(
17
$rpEntity,
18
$publicKeyCredentialSourceRepository
19
);
20
$server->setMetadataStatementRepository($myMetadataStatementRepository); // Inject your new service here
Copied!

The Hard Way

There are few steps to acheive. First, you have to add support classes for all attestation statement types into your Attestation Metatdata Manager.
The Android SafetyNet Attestation Statement is a JWT that can be verified by the library, but can also be checked online by hitting the Google API. This method drastically increase the security for the attestation type but requires a PSR-18 compatible HTTP Client and an API key.
1
<?php
2
3
declare(strict_types=1);
4
5
use Cose\Algorithm\Manager;
6
use Cose\Algorithm\Signature\ECDSA;
7
use Cose\Algorithm\Signature\EdDSA;
8
use Cose\Algorithm\Signature\RSA;
9
use Webauthn\AttestationStatement\AndroidSafetyNetAttestationStatementSupport;
10
use Webauthn\AttestationStatement\AndroidKeyAttestationStatementSupport;
11
use Webauthn\AttestationStatement\AttestationStatementSupportManager;
12
use Webauthn\AttestationStatement\FidoU2FAttestationStatementSupport;
13
use Webauthn\AttestationStatement\NoneAttestationStatementSupport;
14
use Webauthn\AttestationStatement\PackedAttestationStatementSupport;
15
use Webauthn\AttestationStatement\TPMAttestationStatementSupport;
16
use Webauthn\AttestationStatement\AppleAttestationStatementSupport;
17
18
// You normally already do this
19
$attestationStatementSupportManager = new AttestationStatementSupportManager();
20
$attestationStatementSupportManager->add(new NoneAttestationStatementSupport());
21
22
// Additional classes to add
23
$attestationStatementSupportManager->add(new FidoU2FAttestationStatementSupport());
24
$attestationStatementSupportManager->add(new AppleAttestationStatementSupport());
25
$attestationStatementSupportManager->add(new AndroidSafetyNetAttestationStatementSupport());
26
$attestationStatementSupportManager->add(new AndroidKeyAttestationStatementSupport(
27
$psr18Client, // Can be null if you don’t want to use the Google API
28
$googleApiKey, // Can be null if you don’t want to use the Google API
29
$psr17RequestFactory // Can be null if you don’t want to use the Google API
30
));
31
$attestationStatementSupportManager->add(new TPMAttestationStatementSupport());
32
33
// Cose Algorithm Manager
34
// The list of algorithm depends on the algorithm list you defined in your options
35
// You should use at least ES256 and RS256 algorithms that are widely used.
36
$coseAlgorithmManager = new Manager();
37
$coseAlgorithmManager->add(new ECDSA\ES256());
38
$coseAlgorithmManager->add(new RSA\RS256());
39
40
$attestationStatementSupportManager->add(new PackedAttestationStatementSupport($coseAlgorithmManager));
Copied!
Next, you must inject the Metadata Statement Repository to your Attestation Object Loader.
1
$attestationObjectLoader = new AttestationObjectLoader($attestationStatementSupportManager, $metadataStatementRepository);
Copied!

The Symfony Way

With Symfony, you must enable this feature to enable all the metadata types.
config/packages/webauthn.yaml
1
webauthn:
2
metadata_service:
3
enabled: true
4
repository: 'App\Repository\MyMetadataStatementRepository'
Copied!
You can set the Google API key for the Android SafetyNet Attestation Statement support with the following configuration:
1
webauthn:
2
android_safetynet:
3
http_client: 'my.psr18.http.client'
4
request_factory: 'my.psr17.request_factory'
Copied!
If you have some troubles when validating Android SafetyNet Attestation Statement, this may be caused by the leeway of the server clocks or the age of the statement. You can modify the default values as follows:
1
webauthn:
2
android_safetynet:
3
max_age: 60000 # in milliseconds. Default set to 60000 = 1 min
4
leeway: 2000 # in milliseconds. Default set to 0
Copied!
The modification of these parameters is not recommended. You should try to sync your server clock first.

Credential Creation Options

By default, no Attestation Statement is asked to the Authenticators (type = none). To change this behavior, you just have to set the corresponding parameter in the Webauthn\PublicKeyCredentialCreationOptions object.
There are 3 conveyance modes available using PHP constants provided by the class Webauthn\PublicKeyCredentialCreationOptions:
  • ATTESTATION_CONVEYANCE_PREFERENCE_NONE: the Relying Party is not interested in authenticator attestation (default)
  • ATTESTATION_CONVEYANCE_PREFERENCE_INDIRECT: the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements.
  • ATTESTATION_CONVEYANCE_PREFERENCE_DIRECT: the Relying Party wants to receive the attestation statement as generated by the authenticator.

The Easy Way

1
<?php
2
3
use Webauthn\PublicKeyCredentialCreationOptions;
4
5
$publicKeyCredentialCreationOptions = $server->generatePublicKeyCredentialCreationOptions(
6
$userEntity,
7
PublicKeyCredentialCreationOptions::ATTESTATION_CONVEYANCE_PREFERENCE_DIRECT,
8
);
Copied!

The Hard Way

1
<?php
2
3
use Webauthn\PublicKeyCredentialCreationOptions;
4
5
$publicKeyCredentialCreationOptions = new PublicKeyCredentialCreationOptions(
6
$relyingParty
7
$userEntity,
8
$challenge,
9
$pubKeyCredParams,
10
$timeout,
11
$excludeCredentials,
12
$authenticatorSelection,
13
PublicKeyCredentialCreationOptions::ATTESTATION_CONVEYANCE_PREFERENCE_DIRECT
14
);
Copied!

The Symfony Way

config/packages/webauthn.yaml
1
webauthn:
2
credential_repository: ...
3
user_repository: ...
4
creation_profiles:
5
acme:
6
attestation_conveyance: !php/const Webauthn\PublicKeyCredentialCreationOptions::ATTESTATION_CONVEYANCE_PREFERENCE_DIRECT
7
rp:
8
name: 'My application'
9
id: 'example.com'
Copied!
Last modified 2mo ago