versia-pub/api
2
0
Fork 0
mirror of https://github.com/versia-pub/api.git synced 2026-03-13 04:09:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(federation): 📝 Update READMEs and some docstrings

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-05-14 12:56:59 -10:00
parent b86933e77d
commit e34bd84b0c
No known key found for this signature in database
3 changed files with 73 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

4
federation/cryptography/index.test.ts
View file

@ -1,5 +1,5 @@
import { describe, beforeAll, test, expect, beforeEach } from "bun:test";
import { SignatureValidator, SignatureConstructor } from "./index";
import { beforeAll, beforeEach, describe, expect, test } from "bun:test";
import { SignatureConstructor, SignatureValidator } from "./index";
describe("SignatureValidator", () => {
let validator: SignatureValidator;

12
federation/cryptography/index.ts
View file

@ -189,6 +189,11 @@ export class SignatureConstructor {
/**
* Creates a new instance of SignatureConstructor.
* @param privateKey The private key used for signature generation.
* @param keyId The key ID used for the Signature header.
* @example
* const privateKey = // CryptoKey
* const keyId = "https://example.com/users/6a18f2c3-120e-4949-bda4-2aa4c8264d51";
* const constructor = new SignatureConstructor(privateKey, keyId);
*/
constructor(
private privateKey: CryptoKey,
@ -200,10 +205,12 @@ export class SignatureConstructor {
/**
* Creates a SignatureConstructor instance from a base64-encoded private key.
* @param base64PrivateKey The base64-encoded private key.
* @param keyId The key ID used for the Signature header.
* @returns A Promise that resolves to a SignatureConstructor instance.
* @example
* const privateKey = "base64PrivateKey";
* const constructor = await SignatureConstructor.fromStringKey(privateKey);
* const keyId = "https://example.com/users/6a18f2c3-120e-4949-bda4-2aa4c8264d51";
* const constructor = await SignatureConstructor.fromStringKey(privateKey, keyId);
*/
static async fromStringKey(
base64PrivateKey: string,
@ -243,8 +250,7 @@ export class SignatureConstructor {
* const method = "GET";
* const url = new URL("https://example.com");
* const body = "request body";
* const headers = new Headers();
* const signedHeaders = await constructor.sign(method, url, body, headers);
* const signedHeaders = await constructor.sign(method, url, body);
*/
async sign(
method: HttpVerb,