summaryrefslogtreecommitdiffhomepage
path: root/packages/server/src
diff options
context:
space:
mode:
authorMatthew Miller <matthew@millerti.me>2020-06-02 15:14:31 -0700
committerMatthew Miller <matthew@millerti.me>2020-06-02 15:14:31 -0700
commite82c9e9f813897015c9054aa6d279e8ca4279f07 (patch)
treee8e434b9b95362a86f70c93b89c6f94434ba42ad /packages/server/src
parent2ed2974517eb934f878b3e0fb0baa024646979c4 (diff)
Standardize on use of “base64url” where applicable
Diffstat (limited to 'packages/server/src')
-rw-r--r--packages/server/src/assertion/generateAssertionOptions.ts2
-rw-r--r--packages/server/src/assertion/verifyAssertionResponse.ts2
-rw-r--r--packages/server/src/attestation/generateAttestationOptions.ts2
-rw-r--r--packages/server/src/attestation/verifyAttestationResponse.ts6
-rw-r--r--packages/server/src/helpers/decodeAttestationObject.ts4
5 files changed, 8 insertions, 8 deletions
diff --git a/packages/server/src/assertion/generateAssertionOptions.ts b/packages/server/src/assertion/generateAssertionOptions.ts
index 9444a54..ca699c6 100644
--- a/packages/server/src/assertion/generateAssertionOptions.ts
+++ b/packages/server/src/assertion/generateAssertionOptions.ts
@@ -15,7 +15,7 @@ type Options = {
* Prepare a value to pass into navigator.credentials.get(...) for authenticator "login"
*
* @param challenge Random string the authenticator needs to sign and pass back
- * @param allowedBase64CredentialIDs Array of base64-encoded authenticator IDs registered by the
+ * @param allowedBase64CredentialIDs Array of base64url-encoded authenticator IDs registered by the
* user for assertion
* @param timeout How long (in ms) the user can take to complete assertion
* @param suggestedTransports Suggested types of authenticators for assertion
diff --git a/packages/server/src/assertion/verifyAssertionResponse.ts b/packages/server/src/assertion/verifyAssertionResponse.ts
index f19c548..7d13271 100644
--- a/packages/server/src/assertion/verifyAssertionResponse.ts
+++ b/packages/server/src/assertion/verifyAssertionResponse.ts
@@ -13,7 +13,7 @@ import parseAuthenticatorData from '../helpers/parseAuthenticatorData';
/**
* Verify that the user has legitimately completed the login process
*
- * @param response Authenticator assertion response with base64-encoded values
+ * @param response Authenticator assertion response with base64url-encoded values
* @param expectedChallenge The random value provided to generateAssertionOptions for the
* authenticator to sign
* @param expectedOrigin Expected URL of website assertion should have occurred on
diff --git a/packages/server/src/attestation/generateAttestationOptions.ts b/packages/server/src/attestation/generateAttestationOptions.ts
index 89ac86a..25008c0 100644
--- a/packages/server/src/attestation/generateAttestationOptions.ts
+++ b/packages/server/src/attestation/generateAttestationOptions.ts
@@ -30,7 +30,7 @@ type Options = {
* @param userDisplayName User's actual name
* @param timeout How long (in ms) the user can take to complete attestation
* @param attestationType Specific attestation statement
- * @param excludedBase64CredentialIDs Array of base64-encoded authenticator IDs registered by the
+ * @param excludedBase64CredentialIDs Array of base64url-encoded authenticator IDs registered by the
* user so the user can't register the same credential multiple times
* @param suggestedTransports Suggested types of authenticators for attestation
* @param authenticatorSelection Advanced criteria for restricting the types of authenticators that
diff --git a/packages/server/src/attestation/verifyAttestationResponse.ts b/packages/server/src/attestation/verifyAttestationResponse.ts
index 2f81fdc..ed4ac5c 100644
--- a/packages/server/src/attestation/verifyAttestationResponse.ts
+++ b/packages/server/src/attestation/verifyAttestationResponse.ts
@@ -13,7 +13,7 @@ import verifyAndroidSafetynet from './verifications/verifyAndroidSafetyNet';
/**
* Verify that the user has legitimately completed the registration process
*
- * @param response Authenticator attestation response with base64-encoded values
+ * @param response Authenticator attestation response with base64url-encoded values
* @param expectedChallenge The random value provided to generateAttestationOptions for the
* authenticator to sign
* @param expectedOrigin Expected URL of website attestation should have occurred on
@@ -77,9 +77,9 @@ export default function verifyAttestationResponse(
* @param authenticatorInfo.fmt Type of attestation
* @param authenticatorInfo.counter The number of times the authenticator reported it has been used.
* Should be kept in a DB for later reference to help prevent replay attacks
- * @param authenticatorInfo.base64PublicKey Base64-encoded ArrayBuffer containing the
+ * @param authenticatorInfo.base64PublicKey Base64URL-encoded ArrayBuffer containing the
* authenticator's public key. **Should be kept in a DB for later reference!**
- * @param authenticatorInfo.base64CredentialID Base64-encoded ArrayBuffer containing the
+ * @param authenticatorInfo.base64CredentialID Base64URL-encoded ArrayBuffer containing the
* authenticator's credential ID for the public key above. **Should be kept in a DB for later
* reference!**
*/
diff --git a/packages/server/src/helpers/decodeAttestationObject.ts b/packages/server/src/helpers/decodeAttestationObject.ts
index 374dbf4..2eb9997 100644
--- a/packages/server/src/helpers/decodeAttestationObject.ts
+++ b/packages/server/src/helpers/decodeAttestationObject.ts
@@ -2,9 +2,9 @@ import base64url from 'base64url';
import cbor from 'cbor';
/**
- * Convert an AttestationObject from base64 string to a proper object
+ * Convert an AttestationObject from base64url string to a proper object
*
- * @param base64AttestationObject Base64-encoded Attestation Object
+ * @param base64AttestationObject Base64URL-encoded Attestation Object
*/
export default function decodeAttestationObject(
base64AttestationObject: string,