Add docs to top of verify methods

4 files changed, 12 insertions, 2 deletions

diff --git a/src/attestation/verifications/verifyAndroidSafetyNet.ts b/src/attestation/verifications/verifyAndroidSafetyNet.ts
index 8e0c6e4..f044add 100644
--- a/src/attestation/verifications/verifyAndroidSafetyNet.ts
+++ b/src/attestation/verifications/verifyAndroidSafetyNet.ts
@@ -15,6 +15,9 @@ import getCertificateInfo from '@helpers/getCertificateInfo';
 import parseAttestationAuthData from '../parseAttestationAuthData';
 
 
+/**
+ * Verify an attestation response with fmt 'android-safetynet'
+ */
 export default function verifyAttestationAndroidSafetyNet(
   attestationObject: AttestationObject,
   base64ClientDataJSON: string,
diff --git a/src/attestation/verifications/verifyFIDOU2F.ts b/src/attestation/verifications/verifyFIDOU2F.ts
index 12cc808..6e01d60 100644
--- a/src/attestation/verifications/verifyFIDOU2F.ts
+++ b/src/attestation/verifications/verifyFIDOU2F.ts
@@ -9,8 +9,9 @@ import verifySignature from '@helpers/verifySignature';
 import parseAttestationAuthData from '../parseAttestationAuthData';
 
 
-
-
+/**
+ * Verify an attestation response with fmt 'fido-u2f'
+ */
 export default function verifyAttestationFIDOU2F(
   attestationObject: AttestationObject,
   base64ClientDataJSON: string,
diff --git a/src/attestation/verifications/verifyNone.ts b/src/attestation/verifications/verifyNone.ts
index 589d143..7835559 100644
--- a/src/attestation/verifications/verifyNone.ts
+++ b/src/attestation/verifications/verifyNone.ts
@@ -5,7 +5,10 @@ import convertCOSEtoPKCS from "@helpers/convertCOSEtoPKCS";
 
 import parseAttestationAuthData from '../parseAttestationAuthData';
 
+
 /**
+ * Verify an attestation response with fmt 'none'
+ *
  * This is the weaker of the assertions, so there are only so many checks we can perform
  */
 export default function verifyAttestationNone(
diff --git a/src/attestation/verifications/verifyPacked.ts b/src/attestation/verifications/verifyPacked.ts
index ec6cb59..304b00b 100644
--- a/src/attestation/verifications/verifyPacked.ts
+++ b/src/attestation/verifications/verifyPacked.ts
@@ -13,6 +13,9 @@ import verifySignature from '@helpers/verifySignature';
 import parseAttestationAuthData from '../parseAttestationAuthData';
 
 
+/**
+ * Verify an attestation response with fmt 'packed'
+ */
 export default function verifyAttestationPacked(attestationObject: AttestationObject,
   base64ClientDataJSON: string,
 ): VerifiedAttestation {