-
Notifications
You must be signed in to change notification settings - Fork 0
feat(pq-key-fingerprint/ts): phase 1 - rebuild source API surface (ENG-1760) #22
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /** Base error for pq-key-fingerprint failures. */ | ||
| export class FingerprintError extends Error { | ||
| constructor(message: string) { | ||
| super(message); | ||
| this.name = 'FingerprintError'; | ||
| Object.setPrototypeOf(this, new.target.prototype); | ||
| } | ||
| } | ||
|
|
||
| /** Error for invalid or missing fingerprint input values. */ | ||
| export class InvalidFingerprintInputError extends FingerprintError { | ||
| constructor(message: string) { | ||
| super(message); | ||
| this.name = 'InvalidFingerprintInputError'; | ||
| } | ||
| } | ||
|
|
||
| /** Error for key-type mismatches, such as passing private keys. */ | ||
| export class InvalidKeyTypeError extends FingerprintError { | ||
| constructor(message: string) { | ||
| super(message); | ||
| this.name = 'InvalidKeyTypeError'; | ||
| } | ||
| } | ||
|
|
||
| /** Error for unsupported digest algorithm selections. */ | ||
| export class UnsupportedDigestError extends FingerprintError { | ||
| constructor(message: string) { | ||
| super(message); | ||
| this.name = 'UnsupportedDigestError'; | ||
| } | ||
| } | ||
|
|
||
| /** Error for missing runtime cryptographic capabilities. */ | ||
| export class RuntimeCapabilityError extends FingerprintError { | ||
| constructor(message: string) { | ||
| super(message); | ||
| this.name = 'RuntimeCapabilityError'; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,2 @@ | ||
| // pq-key-fingerprint - Generate fingerprints/hashes of PQ public keys | ||
| // Implementation coming soon | ||
|
|
||
| export {}; | ||
| export * from './errors'; | ||
| export * from './types'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import type { AlgorithmName as EncoderAlgorithmName, KeyData, PQJwk } from 'pq-key-encoder'; | ||
|
|
||
| export type { AlgorithmName } from 'pq-key-encoder'; | ||
|
|
||
| export type FingerprintDigest = 'SHA-256' | 'SHA-384' | 'SHA-512'; | ||
|
|
||
| export type FingerprintEncoding = 'hex' | 'base64' | 'base64url' | 'bytes'; | ||
|
|
||
| export interface FingerprintOptions { | ||
| digest?: FingerprintDigest; | ||
| encoding?: FingerprintEncoding; | ||
| } | ||
eacet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| export type PublicKeyData = Omit<KeyData, 'type' | 'alg'> & { | ||
| alg: EncoderAlgorithmName; | ||
| type: 'public'; | ||
| }; | ||
|
|
||
| export type PublicKeyInput = PublicKeyData | { alg: EncoderAlgorithmName; bytes: Uint8Array }; | ||
|
|
||
| export type FingerprintInput = PublicKeyInput | Uint8Array | string | PQJwk; | ||
eacet marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| export type FingerprintResult = string | Uint8Array; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the 'test': 'bun test' script since no test files exist yet. The bun test runner fails when it cannot find any files with test naming conventions (.test, test, .spec, spec). This script should be added back when actual test files are implemented.
Spotted by Graphite (based on CI logs)

Is this helpful? React 👍 or 👎 to let us know.