From fb732e401eaf1a9a0d1ff65fcb29343de201c140 Mon Sep 17 00:00:00 2001
From: Matthew Miller <matthew@millerti.me>
Date: Thu, 15 Apr 2021 21:49:14 -0700
Subject: Unify naming convention of string<->buffer helpers

---
 packages/browser/src/helpers/stringToArrayBuffer.ts   |  7 -------
 packages/browser/src/helpers/utf8StringToBuffer.ts    |  7 +++++++
 packages/browser/src/methods/startAssertion.test.ts   | 10 +++++-----
 packages/browser/src/methods/startAttestation.test.ts |  6 +++---
 packages/browser/src/methods/startAttestation.ts      |  4 ++--
 5 files changed, 17 insertions(+), 17 deletions(-)
 delete mode 100644 packages/browser/src/helpers/stringToArrayBuffer.ts
 create mode 100644 packages/browser/src/helpers/utf8StringToBuffer.ts

(limited to 'packages/browser/src')

diff --git a/packages/browser/src/helpers/stringToArrayBuffer.ts b/packages/browser/src/helpers/stringToArrayBuffer.ts
deleted file mode 100644
index e3edd41..0000000
--- a/packages/browser/src/helpers/stringToArrayBuffer.ts
+++ /dev/null
@@ -1,7 +0,0 @@
-/**
- * A helper method to convert an arbitrary string sent from the server to a Uint8Array the
- * authenticator will expect.
- */
-export default function stringToArrayBuffer(value: string): ArrayBuffer {
-  return new TextEncoder().encode(value);
-}
diff --git a/packages/browser/src/helpers/utf8StringToBuffer.ts b/packages/browser/src/helpers/utf8StringToBuffer.ts
new file mode 100644
index 0000000..32cb717
--- /dev/null
+++ b/packages/browser/src/helpers/utf8StringToBuffer.ts
@@ -0,0 +1,7 @@
+/**
+ * A helper method to convert an arbitrary string sent from the server to an ArrayBuffer the
+ * authenticator will expect.
+ */
+export default function utf8StringToBuffer(value: string): ArrayBuffer {
+  return new TextEncoder().encode(value);
+}
diff --git a/packages/browser/src/methods/startAssertion.test.ts b/packages/browser/src/methods/startAssertion.test.ts
index a17c160..f005a26 100644
--- a/packages/browser/src/methods/startAssertion.test.ts
+++ b/packages/browser/src/methods/startAssertion.test.ts
@@ -6,7 +6,7 @@ import {
 } from '@simplewebauthn/typescript-types';
 
 import supportsWebauthn from '../helpers/supportsWebauthn';
-import stringToArrayBuffer from '../helpers/stringToArrayBuffer';
+import utf8StringToBuffer from '../helpers/utf8StringToBuffer';
 import bufferToBase64URLString from '../helpers/bufferToBase64URLString';
 
 import startAssertion from './startAssertion';
@@ -23,7 +23,7 @@ const mockUserHandle = 'mockUserHandle';
 
 // With ASCII challenge
 const goodOpts1: PublicKeyCredentialRequestOptionsJSON = {
-  challenge: bufferToBase64URLString(stringToArrayBuffer('fizz')),
+  challenge: bufferToBase64URLString(utf8StringToBuffer('fizz')),
   allowCredentials: [
     {
       id: 'C0VGlvYFratUdAV1iCw-ULpUW8E-exHPXQChBfyVeJZCMfjMFcwDmOFgoMUz39LoMtCJUBW8WPlLkGT6q8qTCg',
@@ -36,7 +36,7 @@ const goodOpts1: PublicKeyCredentialRequestOptionsJSON = {
 
 // With UTF-8 challenge
 const goodOpts2UTF8: PublicKeyCredentialRequestOptionsJSON = {
-  challenge: bufferToBase64URLString(stringToArrayBuffer('やれやれだぜ')),
+  challenge: bufferToBase64URLString(utf8StringToBuffer('やれやれだぜ')),
   allowCredentials: [],
   timeout: 1,
 };
@@ -78,7 +78,7 @@ test('should convert options before passing to navigator.credentials.get(...)',
 
 test('should support optional allowCredential', async () => {
   await startAssertion({
-    challenge: bufferToBase64URLString(stringToArrayBuffer('fizz')),
+    challenge: bufferToBase64URLString(utf8StringToBuffer('fizz')),
     timeout: 1,
   });
 
@@ -87,7 +87,7 @@ test('should support optional allowCredential', async () => {
 
 test('should convert allow allowCredential to undefined when empty', async () => {
   await startAssertion({
-    challenge: bufferToBase64URLString(stringToArrayBuffer('fizz')),
+    challenge: bufferToBase64URLString(utf8StringToBuffer('fizz')),
     timeout: 1,
     allowCredentials: [],
   });
diff --git a/packages/browser/src/methods/startAttestation.test.ts b/packages/browser/src/methods/startAttestation.test.ts
index 0b77743..244a4d2 100644
--- a/packages/browser/src/methods/startAttestation.test.ts
+++ b/packages/browser/src/methods/startAttestation.test.ts
@@ -5,7 +5,7 @@ import {
   PublicKeyCredentialCreationOptionsJSON,
 } from '@simplewebauthn/typescript-types';
 
-import stringToArrayBuffer from '../helpers/stringToArrayBuffer';
+import utf8StringToBuffer from '../helpers/utf8StringToBuffer';
 import supportsWebauthn from '../helpers/supportsWebauthn';
 import bufferToBase64URLString from '../helpers/bufferToBase64URLString';
 
@@ -20,7 +20,7 @@ const mockAttestationObject = 'mockAtte';
 const mockClientDataJSON = 'mockClie';
 
 const goodOpts1: PublicKeyCredentialCreationOptionsJSON = {
-  challenge: bufferToBase64URLString(stringToArrayBuffer('fizz')),
+  challenge: bufferToBase64URLString(utf8StringToBuffer('fizz')),
   attestation: 'direct',
   pubKeyCredParams: [
     {
@@ -90,7 +90,7 @@ test('should return base64url-encoded response values', async done => {
       return new Promise(resolve => {
         resolve({
           id: 'foobar',
-          rawId: stringToArrayBuffer('foobar'),
+          rawId: utf8StringToBuffer('foobar'),
           response: {
             attestationObject: Buffer.from(mockAttestationObject, 'ascii'),
             clientDataJSON: Buffer.from(mockClientDataJSON, 'ascii'),
diff --git a/packages/browser/src/methods/startAttestation.ts b/packages/browser/src/methods/startAttestation.ts
index 5601581..379e295 100644
--- a/packages/browser/src/methods/startAttestation.ts
+++ b/packages/browser/src/methods/startAttestation.ts
@@ -4,7 +4,7 @@ import {
   AttestationCredentialJSON,
 } from '@simplewebauthn/typescript-types';
 
-import stringToArrayBuffer from '../helpers/stringToArrayBuffer';
+import utf8StringToBuffer from '../helpers/utf8StringToBuffer';
 import bufferToBase64URLString from '../helpers/bufferToBase64URLString';
 import base64URLStringToBuffer from '../helpers/base64URLStringToBuffer';
 import supportsWebauthn from '../helpers/supportsWebauthn';
@@ -28,7 +28,7 @@ export default async function startAttestation(
     challenge: base64URLStringToBuffer(creationOptionsJSON.challenge),
     user: {
       ...creationOptionsJSON.user,
-      id: stringToArrayBuffer(creationOptionsJSON.user.id),
+      id: utf8StringToBuffer(creationOptionsJSON.user.id),
     },
     excludeCredentials: creationOptionsJSON.excludeCredentials.map(toPublicKeyCredentialDescriptor),
   };
-- 
cgit v1.2.3