diff options
author | Matthew Miller <matthew@millerti.me> | 2021-09-01 08:54:09 -0700 |
---|---|---|
committer | Matthew Miller <matthew@millerti.me> | 2021-09-01 08:54:09 -0700 |
commit | 2037b3220549f576795a07be131ac43358d02c30 (patch) | |
tree | a25fe2dc6968bca6108b759d066d63d710eeb250 /packages/server/src | |
parent | bb193c61ffe40f757c10ee556150d509290b6856 (diff) |
Clean up some docs
Diffstat (limited to 'packages/server/src')
-rw-r--r-- | packages/server/src/services/metadataService.ts | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/packages/server/src/services/metadataService.ts b/packages/server/src/services/metadataService.ts index 9b2b12b..86cd10d 100644 --- a/packages/server/src/services/metadataService.ts +++ b/packages/server/src/services/metadataService.ts @@ -36,6 +36,8 @@ enum SERVICE_STATE { READY, } +// Allow MetadataService to accommodate unregistered AAGUIDs ("permissive"), or only allow +// registered AAGUIDs ("strict"). Currently primarily impacts how `getStatement()` operates type VerificationMode = 'permissive' | 'strict'; /** @@ -59,8 +61,9 @@ export class BaseMetadataService { * (version 3.0)-compatible servers. Defaults to the official FIDO MDS server * @param opts.statements An array of local metadata statements * @param opts.verificationMode How MetadataService will handle unregistered AAGUIDs. Defaults to - * `"strict"` which throws errors when an unregistered AAGUID is encountered during registration. - * Set to `"permissive"` to allow registration by authenticators with unregistered AAGUIDs + * `"strict"` which throws errors during registration response verification when an + * unregistered AAGUID is encountered. Set to `"permissive"` to allow registration by + * authenticators with unregistered AAGUIDs */ async initialize( opts: { @@ -129,7 +132,7 @@ export class BaseMetadataService { } /** - * Get a metadata statement for a given aaguid. Defaults to returning a cached statement. + * Get a metadata statement for a given AAGUID. * * This method will coordinate updating the cache as per the `nextUpdate` property in the initial * BLOB download. |