Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

230 signature base serialization fix #231

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

230 signature base serialization fix #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2309aeb
* moved all signature input generation from authing to httping
da-tychinin Mar 8, 2024
48b837f
* unit test fix: missing function argument
da-tychinin Mar 8, 2024
342f6c3
* TS5097 import path fix
da-tychinin Mar 8, 2024
4bd7b7d
* run prettier
da-tychinin Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 46 additions & 64 deletions src/keri/core/authing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
import { Signer } from './signer';
import { Verfer } from './verfer';
import { desiginput, normalize, siginput } from './httping';
import { Signage, signature, designature } from '../end/ending';
import { desiginput, sigbase, siginput } from './httping';
import { designature, Signage, signature } from '../end/ending';
import { Cigar } from './cigar';
import { Siger } from './siger';
import { nowUTC } from './utils';
import { b } from './core';

export class Authenticater {
static DefaultFields = [
static readonly DefaultFields = [
'@method',
'@path',
'signify-resource',
Expand All @@ -19,91 +22,70 @@ export class Authenticater {
this._verfer = verfer;
}

verify(headers: Headers, method: string, path: string): boolean {
const siginput = headers.get('Signature-Input');
if (siginput == null) {
verify(
headers: Headers,
method: string,
path: string,
authority?: string
): boolean {
const siginputHeader = headers.get('Signature-Input');
if (siginputHeader == null) {
return false;
}
const signature = headers.get('Signature');
if (signature == null) {
return false;
}
let inputs = desiginput(siginput);
inputs = inputs.filter((input) => input.name == 'signify');
if (inputs.length == 0) {
const inputs = desiginput(siginputHeader);
const input = inputs.get('signify');
if (!input) {
return false;
}
inputs.forEach((input) => {
const items = new Array<string>();
input.fields!.forEach((field: string) => {
if (field.startsWith('@')) {
if (field == '@method') {
items.push(`"${field}": ${method}`);
} else if (field == '@path') {
items.push(`"${field}": ${path}`);
}
} else {
if (headers.has(field)) {
const value = normalize(headers.get(field) as string);
items.push(`"${field}": ${value}`);
}
}
});
const values = new Array<string>();
values.push(`(${input.fields!.join(' ')})`);
values.push(`created=${input.created}`);
if (input.expires != undefined) {
values.push(`expires=${input.expires}`);
}
if (input.nonce != undefined) {
values.push(`nonce=${input.nonce}`);
}
if (input.keyid != undefined) {
values.push(`keyid=${input.keyid}`);
}
if (input.context != undefined) {
values.push(`context=${input.context}`);
}
if (input.alg != undefined) {
values.push(`alg=${input.alg}`);
}
const params = values.join(';');
items.push(`"@signature-params: ${params}"`);
const ser = items.join('\n');
const signage = designature(signature!);
const cig = signage[0].markers.get(input.name);
if (!this._verfer.verify(cig.raw, ser)) {
throw new Error(`Signature for ${input.keyid} invalid.`);
}
});

const ser = sigbase(
input.fields,
siginput(input),
headers,
method,
path,
authority
);
const signage = designature(signature);
const cig = signage[0].markers.get('signify');
if (!this._verfer.verify(cig.raw, ser)) {
throw new Error(`Signature for ${input.keyid} invalid.`);
}
return true;
}

sign(
headers: Headers,
method: string,
path: string,
authority?: string,
fields?: Array<string>
): Headers {
if (fields == undefined) {
fields = Authenticater.DefaultFields;
}

const [header, sig] = siginput(this._csig, {
name: 'signify',
method,
path,
headers,
const input = {
fields,
created: Math.floor(nowUTC().getTime() / 1000),
alg: 'ed25519',
keyid: this._csig.verfer.qb64,
});

header.forEach((value, key) => {
headers.append(key, value);
});
};
const signatureParams = siginput(input);
const signatureBase = sigbase(
fields,
signatureParams,
headers,
method,
path,
authority
);
const sid = `signify=${signatureParams}`;
headers.append('Signature-Input', sid);

const sig = this._csig.sign(b(signatureBase));
const markers = new Map<string, Siger | Cigar>();
markers.set('signify', sig);
const signage = new Signage(markers, false);
Expand Down
149 changes: 64 additions & 85 deletions src/keri/core/httping.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
import {
serializeDictionary,
Dictionary,
parseDictionary,
Item,
Parameters,
parseDictionary,
serializeInnerList,
} from 'structured-headers';
import { Signer } from './signer';
import { b } from './core';
import { Cigar } from './cigar';
import { nowUTC } from './utils';
import { Siger } from './siger';
import Base64 from 'urlsafe-base64';
import { Buffer } from 'buffer';

Expand All @@ -18,99 +13,80 @@ export function normalize(header: string) {
}

export interface SiginputArgs {
name: string;
method: string;
path: string;
authority?: string;
headers: Headers;
fields: Array<string>;
expires?: number;
nonce?: string;
alg?: string;
keyid?: string;
context?: string;
}

export function siginput(
signer: Signer,
{
name,
method,
path,
headers,
fields,
expires,
nonce,
alg,
keyid,
context,
}: SiginputArgs
): [Map<string, string>, Siger | Cigar] {
/**
* Prepare signature-parameters (https://datatracker.ietf.org/doc/html/rfc9421#section-2.3)
* and signature-base (https://datatracker.ietf.org/doc/html/rfc9421#section-2.5) strings based on the following input
* @param fields - signature fields names in a signature order
* @param signatureParams - signature params string
* @param headers - request headers to derive signature input components from
* @param method - request method
* @param path - request path
* @param authority - request authority
*/
export function sigbase(
fields: Array<string>,
signatureParams: string,
headers: Headers,
method: string,
path: string,
authority?: string
): string {
const items = new Array<string>();
const ifields = new Array<[string, Map<string, string>]>();

fields.forEach((field) => {
fields.forEach((field: string) => {
if (field.startsWith('@')) {
switch (field) {
case '@method':
items.push(`"${field}": ${method}`);
ifields.push([field, new Map()]);
break;
case '@path':
items.push(`"${field}": ${path}`);
ifields.push([field, new Map()]);
break;
case '@authority':
items.push(`"${field}": ${authority}`);
break;
}
} else {
if (!headers.has(field)) return;

ifields.push([field, new Map()]);
const value = normalize(headers.get(field)!);
} else if (headers.has(field)) {
const value = normalize(headers.get(field) as string);
items.push(`"${field}": ${value}`);
}
});
items.push(`"@signature-params": ${signatureParams}`);
return items.join('\n');
}

/**
* Build a signature-params string based on the {@link Inputage} values
* @param input - the input values for signature-params
*/
export function siginput(input: Inputage): string {
const ifields = new Array<[string, Map<string, string>]>();
input.fields.forEach((field: string) => {
ifields.push([field, new Map()]);
});
const nameParams = new Map<string, string | number>();
const now = Math.floor(nowUTC().getTime() / 1000);
nameParams.set('created', now);

const values = [
`(${ifields.map((field) => field[0]).join(' ')})`,
`created=${now}`,
];
if (expires != undefined) {
values.push(`expires=${expires}`);
nameParams.set('expires', expires);
nameParams.set('created', input.created);
if (input.expires != undefined) {
nameParams.set('expires', input.expires);
}
if (nonce != undefined) {
values.push(`nonce=${nonce}`);
nameParams.set('nonce', nonce);
if (input.nonce != undefined) {
nameParams.set('nonce', input.nonce);
}
if (keyid != undefined) {
values.push(`keyid=${keyid}`);
nameParams.set('keyid', keyid);
if (input.keyid != undefined) {
nameParams.set('keyid', input.keyid);
}
if (context != undefined) {
values.push(`context=${context}`);
nameParams.set('context', context);
if (input.context != undefined) {
nameParams.set('context', input.context);
}
if (alg != undefined) {
values.push(`alg=${alg}`);
nameParams.set('alg', alg);
if (input.alg != undefined) {
nameParams.set('alg', input.alg);
}
const sid = new Map([[name, [ifields, nameParams]]]);

const params = values.join(';');
items.push(`"@signature-params: ${params}"`);

const ser = items.join('\n');
const sig = signer.sign(b(ser));

return [
new Map<string, string>([
['Signature-Input', `${serializeDictionary(sid as Dictionary)}`],
]),
sig,
];
return serializeInnerList([ifields, nameParams]);
}

export class Unqualified {
Expand All @@ -130,23 +106,25 @@ export class Unqualified {
}

export class Inputage {
public name: any;
public fields: any;
public created: any;
public expires: any;
public nonce: any;
public alg: any;
public keyid: any;
public context: any;
public expires?: any;
public nonce?: any;
public alg?: any;
public keyid?: any;
public context?: any;
}

export function desiginput(value: string): Array<Inputage> {
/**
* Parse a Signature-Input value into an {@link Inputage} by label map
* @param value - Signature-Input string
*/
export function desiginput(value: string): Map<string, Inputage> {
const sid = parseDictionary(value);
const siginputs = new Array<Inputage>();
const siginputs = new Map<string, Inputage>();

sid.forEach((value, key) => {
const siginput = new Inputage();
siginput.name = key;
let list: Item[];
let params;
[list, params] = value as [Item[], Parameters];
Expand Down Expand Up @@ -179,11 +157,12 @@ export function desiginput(value: string): Array<Inputage> {
siginput.context = params.get('context');
}

siginputs.push(siginput);
siginputs.set(key, siginput);
});

return siginputs;
}

/** Parse start, end and total from HTTP Content-Range header value
* @param {string|null} header - HTTP Range header value
* @param {string} typ - type of range, e.g. "aids"
Expand Down
Loading
Loading