feat(types): rename field to authParams

Author: TomokiMiyauci

authorization.json

@@ -1,22 +1,20 @@
 [
-  {
-    "name": "simple authorization header",
-    "header": "basic",
-    "expected": { "authScheme": "basic", "token": null }
-  },
   {
     "name": "basic",
     "ref": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization#basic_authentication",
     "header": "Basic YWxhZGRpbjpvcGVuc2VzYW1l",
-    "expected": { "authScheme": "Basic", "token": "YWxhZGRpbjpvcGVuc2VzYW1l" }
+    "expected": {
+      "authScheme": "Basic",
+      "authParams": "YWxhZGRpbjpvcGVuc2VzYW1l"
+    }
   },
   {
     "name": "bearer",
     "ref": "https://datatracker.ietf.org/doc/html/rfc6750#section-3",
     "header": "Bearer realm=\"example\", error=\"invalid_token\", error_description=\"The access token expired\"",
     "expected": {
       "authScheme": "Bearer",
-      "token": {
+      "authParams": {
         "realm": "\"example\"",
         "error": "\"invalid_token\"",
         "error_description": "\"The access token expired\""
@@ -26,54 +24,54 @@
   {
     "name": "digest",
     "ref": "https://datatracker.ietf.org/doc/html/rfc7616#section-3.9.1",
-    "header": "Digest username=\"Mufasa\",realm=\"[email protected]\",uri=\"/dir/index.html\",algorithm=SHA-256,nonce=\"7ypf/xlj9XXwfDPEoM4URrv/xwf94BcCAzFZH4GiTo0v\",nc=00000001,cnonce=\"f2/wE4q74E6zIJEtWaHKaf5wv/H5QzzpXusqGemxURZJ\",qop=auth,response=\"753927fa0e85d155564e2e272a28d1802ca10daf4496794697cf8db5856cb6c1\",opaque=\"FQhe/qaU925kfnzjCev0ciny7QMkPqMAFRtzCUYo5tdS\"",
+    "header": "Digest username=\"Mufasa\", realm=\"[email protected]\", uri=\"/dir/index.html\", algorithm=SHA-256, nonce=\"7ypf/xlj9XXwfDPEoM4URrv/xwf94BcCAzFZH4GiTo0v\", nc=00000001, cnonce=\"f2/wE4q74E6zIJEtWaHKaf5wv/H5QzzpXusqGemxURZJ\", qop=auth, response=\"753927fa0e85d155564e2e272a28d1802ca10daf4496794697cf8db5856cb6c1\", opaque=\"FQhe/qaU925kfnzjCev0ciny7QMkPqMAFRtzCUYo5tdS\"",
     "expected": {
       "authScheme": "Digest",
-      "token": {
+      "authParams": {
+        "username": "\"Mufasa\"",
+        "realm": "\"[email protected]\"",
+        "uri": "\"/dir/index.html\"",
         "algorithm": "SHA-256",
-        "cnonce": "\"f2/wE4q74E6zIJEtWaHKaf5wv/H5QzzpXusqGemxURZJ\"",
-        "nc": "00000001",
         "nonce": "\"7ypf/xlj9XXwfDPEoM4URrv/xwf94BcCAzFZH4GiTo0v\"",
-        "opaque": "\"FQhe/qaU925kfnzjCev0ciny7QMkPqMAFRtzCUYo5tdS\"",
+        "nc": "00000001",
+        "cnonce": "\"f2/wE4q74E6zIJEtWaHKaf5wv/H5QzzpXusqGemxURZJ\"",
         "qop": "auth",
-        "realm": "\"[email protected]\"",
         "response": "\"753927fa0e85d155564e2e272a28d1802ca10daf4496794697cf8db5856cb6c1\"",
-        "uri": "\"/dir/index.html\"",
-        "username": "\"Mufasa\""
+        "opaque": "\"FQhe/qaU925kfnzjCev0ciny7QMkPqMAFRtzCUYo5tdS\""
       }
     }
   },
   {
     "name": "Example with SHA-512-256, Charset, and Userhash",
-    "header": "Digest username=\"488869477bf257147b804c45308cd62ac4e25eb717b12b298c79e62dcea254ec\",realm=\"[email protected]\",uri=\"/doe.json\",algorithm=SHA-512-256,nonce=\"5TsQWLVdgBdmrQ0XsxbDODV+57QdFR34I9HAbC/RVvkK\",nc=00000001,cnonce=\"NTg6RKcb9boFIAS3KrFK9BGeh+iDa/sm6jUMp2wds69v\",qop=auth,response=\"ae66e67d6b427bd3f120414a82e4acff38e8ecd9101d6c861229025f607a79dd\",opaque=\"HRPCssKJSGjCrkzDg8OhwpzCiGPChXYjwrI2QmXDnsOS\",userhash=true",
+    "header": "Digest username=\"488869477bf257147b804c45308cd62ac4e25eb717b12b298c79e62dcea254ec\", realm=\"[email protected]\", uri=\"/doe.json\", algorithm=SHA-512-256, nonce=\"5TsQWLVdgBdmrQ0XsxbDODV+57QdFR34I9HAbC/RVvkK\", nc=00000001, cnonce=\"NTg6RKcb9boFIAS3KrFK9BGeh+iDa/sm6jUMp2wds69v\", qop=auth, response=\"ae66e67d6b427bd3f120414a82e4acff38e8ecd9101d6c861229025f607a79dd\", opaque=\"HRPCssKJSGjCrkzDg8OhwpzCiGPChXYjwrI2QmXDnsOS\", userhash=true",
     "ref": "https://datatracker.ietf.org/doc/html/rfc7616#section-3.9.2",
     "expected": {
       "authScheme": "Digest",
-      "token": {
+      "authParams": {
+        "username": "\"488869477bf257147b804c45308cd62ac4e25eb717b12b298c79e62dcea254ec\"",
+        "realm": "\"[email protected]\"",
+        "uri": "\"/doe.json\"",
         "algorithm": "SHA-512-256",
-        "cnonce": "\"NTg6RKcb9boFIAS3KrFK9BGeh+iDa/sm6jUMp2wds69v\"",
-        "nc": "00000001",
         "nonce": "\"5TsQWLVdgBdmrQ0XsxbDODV+57QdFR34I9HAbC/RVvkK\"",
-        "opaque": "\"HRPCssKJSGjCrkzDg8OhwpzCiGPChXYjwrI2QmXDnsOS\"",
+        "nc": "00000001",
+        "cnonce": "\"NTg6RKcb9boFIAS3KrFK9BGeh+iDa/sm6jUMp2wds69v\"",
         "qop": "auth",
-        "realm": "\"[email protected]\"",
         "response": "\"ae66e67d6b427bd3f120414a82e4acff38e8ecd9101d6c861229025f607a79dd\"",
-        "uri": "\"/doe.json\"",
-        "userhash": "true",
-        "username": "\"488869477bf257147b804c45308cd62ac4e25eb717b12b298c79e62dcea254ec\""
+        "opaque": "\"HRPCssKJSGjCrkzDg8OhwpzCiGPChXYjwrI2QmXDnsOS\"",
+        "userhash": "true"
       }
     }
   },
   {
     "name": "Example for AWS4-HMAC-SHA256",
-    "header": "AWS4-HMAC-SHA256 Credential=\"AKIAIOSFODNN7EXAMPLE/20130524/us-east-1/s3/aws4_request\", SignedHeaders=\"host;range;x-amz-date\",Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024",
+    "header": "AWS4-HMAC-SHA256 Credential=\"AKIAIOSFODNN7EXAMPLE/20130524/us-east-1/s3/aws4_request\", SignedHeaders=\"host;range;x-amz-date\", Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024",
     "ref": "https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html",
     "expected": {
       "authScheme": "AWS4-HMAC-SHA256",
-      "token": {
+      "authParams": {
         "Credential": "\"AKIAIOSFODNN7EXAMPLE/20130524/us-east-1/s3/aws4_request\"",
-        "Signature": "fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024",
-        "SignedHeaders": "\"host;range;x-amz-date\""
+        "SignedHeaders": "\"host;range;x-amz-date\"",
+        "Signature": "fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024"
       }
     }
   },

constants.ts

@@ -0,0 +1,9 @@
+// Copyright 2023-latest the httpland authors. All rights reserved. MIT license.
+// This module is browser compatible.
+
+export const enum Msg {
+  InvalidSyntax = "unexpected Authorization input",
+  DuplicatedKeys = "auth param keys should be case insensitive unique",
+  InvalidToken = "should be <token> format",
+  InvalidToken68 = "should be <token68> format",
+}

parse.ts

@@ -2,13 +2,9 @@
 // This module is browser compatible.
 
 import { duplicate, parseList } from "./utils.ts";
-import { head, toLowerCase } from "./deps.ts";
-import type { Authorization, AuthParam } from "./types.ts";
-
-const enum Msg {
-  InvalidSyntax = "unexpected Authorization input",
-  DuplicatedKeys = "auth param keys should be case insensitive unique",
-}
+import { head, isString, toLowerCase } from "./deps.ts";
+import { Msg } from "./constants.ts";
+import type { Authorization, AuthParams } from "./types.ts";
 
 const reAuthorization =
   /^(?<authScheme>[!#$%&'*+.^_`|~\dA-Za-z-]+)(?: +(?:(?<token68>(?:[A-Za-z]|\d|[-._~+/])+=*)|(?<authParam>.+)))?$/;
@@ -46,19 +42,28 @@ export function parseAuthorization(input: string): Authorization {
 
   if (!result || !result.groups) throw SyntaxError(Msg.InvalidSyntax);
 
-  const { authScheme, token68, authParam: authParamStr } = result.groups;
-  const token = authParamStr ? parseAuthParam(authParamStr) : token68 ?? null;
+  const groups = result.groups as ParsedGroups;
+  const { authScheme } = groups;
+  const authParams = isString(groups.authParam)
+    ? parseAuthParams(groups.authParam)
+    : groups.token68;
 
-  return { authScheme: authScheme!, token };
+  return { authScheme, authParams: authParams ?? null };
 }
 
+type ParsedGroups = {
+  readonly authScheme: string;
+  readonly token68: string | undefined;
+  readonly authParam: string | undefined;
+};
+
 const reAuthParam =
   /^(?<key>[!#$%&'*+.^_`|~\dA-Za-z-]+)[ \t]*=[ \t]*(?<value>[!#$%&'*+.^_`|~\dA-Za-z-]+|"(?:\t| |!|[\x23-\x5B/, /[\x5D-\x7E]|[\x80-\xFF]|\\(?:\t| |[\x21-\x7E])[\x80-\xFF])*")$/;
 
 /** Parse string into {@link AuthParam}.
  * @throws {Error} If the auth param key is duplicated.
  */
-export function parseAuthParam(input: string): AuthParam {
+export function parseAuthParams(input: string): AuthParams {
   const list = parseList(input);
 
   const entries = list.map((el) => {

parse_test.ts

@@ -1,4 +1,4 @@
-import { parseAuthorization, parseAuthParam } from "./parse.ts";
+import { parseAuthorization, parseAuthParams } from "./parse.ts";
 import {
   assertEquals,
   assertIsError,
@@ -49,14 +49,14 @@ describe("parseAuthorization", () => {
   });
 });
 
-describe("parseAuthParam", () => {
+describe("parseAuthParams", () => {
   authParam.forEach((v) => {
     it(v.name, () => {
       if (v.must_fail) {
-        assertThrows(() => parseAuthParam(v.header));
+        assertThrows(() => parseAuthParams(v.header));
       } else {
         assertEquals<Record<string, unknown>>(
-          parseAuthParam(v.header),
+          parseAuthParams(v.header),
           v.expected!,
         );
       }

types.ts

@@ -1,13 +1,13 @@
 // Copyright 2023-latest the httpland authors. All rights reserved. MIT license.
 // This module is browser compatible.
 
-/** Authorization API. */
-export interface Authorization {
+/** Credentials API. */
+export interface Credentials {
   /** Authentication scheme. */
   readonly authScheme: string;
 
-  /** token68 or auth-param. */
-  readonly token: Token68 | AuthParam | null;
+  /** Authentication parameters. */
+  readonly authParams: Token68 | AuthParams | null;
 }
 
 /** Representation of [token68](https://www.rfc-editor.org/rfc/rfc9110.html#auth.params). */
@@ -16,6 +16,8 @@ export type Token68 = string;
 /** Pair of name and value.
  * Representation of [auth-param](https://www.rfc-editor.org/rfc/rfc9110.html#section-11.2-5).
  */
-export interface AuthParam {
+export interface AuthParams {
   readonly [k: string]: string;
 }
+
+export type Authorization = Credentials;