-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
8 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
|
@@ -2,18 +2,18 @@ | |
|
||
[![CI](https://github.com/wiktor-k/ssh-browser-test/actions/workflows/ci.yml/badge.svg)](https://github.com/wiktor-k/ssh-browser-test/actions/workflows/ci.yml) | ||
|
||
Provides SSH signature parser and verifier for | ||
Provides an SSH signature parser and verifier for | ||
[SSH file signatures](https://www.agwa.name/blog/post/ssh_signatures). | ||
|
||
SSH signatures allow signing arbitrary files and can be used for | ||
[signing git commits and tags](https://blog.dbrgn.ch/2021/11/16/git-ssh-signatures/). | ||
|
||
All features are implemented using pure TypeScript and built-in | ||
All features are implemented using pure TypeScript and the built-in | ||
[SubtleCrypto](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto). | ||
|
||
Since [`Ed25519` public keys](https://wicg.github.io/webcrypto-secure-curves/) | ||
Since [`ed25519` public keys](https://wicg.github.io/webcrypto-secure-curves/) | ||
are | ||
[not yet widely deployed](https://caniuse.com/mdn-api_subtlecrypto_verify_ed25519) | ||
[not yet widely deployed](https://caniuse.com/mdn-api_subtlecrypto_verify_ed25519), | ||
this package allows supplying custom `SubtleCrypto` implementation, such as | ||
[`webcrypto-ed25519`](https://github.com/jacobbubu/webcrypto-ed25519). | ||
|
||
|
@@ -42,9 +42,9 @@ in Deno) | |
|
||
[^2]: Requires support for P-521 (not available in Deno, so not tested) | ||
|
||
Which represents almost all | ||
This represents almost all | ||
[available algorithms](https://man.archlinux.org/man/ssh-keygen.1#t) with the | ||
exception of DSA which is unsupported by WebCrypto and obsolete. | ||
exception of DSA, which is unsupported by WebCrypto and obsolete. | ||
|
||
If you encounter a problem verifying signatures with combinations of digests | ||
that we do not have in our testing suite, please | ||
|
@@ -77,8 +77,8 @@ const valid = await verify( | |
assertEquals(valid, true, "signature is valid"); | ||
``` | ||
|
||
Signatures can also be parsed before verification. Since signatures contain | ||
public keys it's also possible to export the public key in the SSH format: | ||
Signatures can also be parsed before verification. As signatures contain public | ||
keys it is also possible to export the public key in the SSH format: | ||
|
||
```typescript | ||
import { assertEquals } from "https://deno.land/[email protected]/assert/mod.ts"; | ||
|