Skip to content

Commit

Permalink
Update README with added support for importKey and exportKey
Browse files Browse the repository at this point in the history
  • Loading branch information
oleiade committed Mar 28, 2023
1 parent b30f6cc commit 9de2272
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ The current state of the project is that it is an experimental, and incomplete i

#### SubtleCrypto

- `crypto.subtle.digest()` supports the complete specification's algorithms list: SHA-1, SHA-256, SHA-384, SHA-512.
- `crypto.subtle.generateKey()` supports the following symmetric algorithms: AES-CBC, AES-GCM, and AES-CTR.
- `crypto.subtle.digest(algorithm)` supports the complete specification's algorithms list: SHA-1, SHA-256, SHA-384, SHA-512.
- `crypto.subtle.generateKey(algorithm, extractable, keyUsages)` supports the following symmetric algorithms: AES-CBC, AES-GCM, and AES-CTR.
- `crypto.subtle.importKey(format, keyData, algorithm, extractable, keyUsages)` supports the following symmetric algorithms: AES-CBC, AES-GCM, and AES-CTR.
- `crypto.subtle.exportKey(format, key)` supports the following symmetric algorithms: AES-CBC, AES-GCM, and AES-CTR.

### APIs and algorithms with limited support

Expand All @@ -29,6 +31,6 @@ Contributions are welcome!

### Practices

Contributors will likely notice that the codebase is annotated with comments of the form `// {some number}.`. Those comments are used to track the progress of the implementation of the specification. The numbers are the section numbers of the specification. For example, the comment `// 8.` in the `SubtleCrypto.GenerateKey` function refers to the [step 8 of the `generateKey` algorithm from the specification](https://www.w3.org/TR/WebCryptoAPI/#SubtleCrypto-method-generateKey).
Contributors will likely notice that the codebase is annotated with comments of the form `// {some number}.`. Those comments are used to track the progress of the implementation of the specification and to ensure the correctness of the implementation of the algorithms. The numbers are the section numbers of the specification. For example, the comment `// 8.` in the `SubtleCrypto.GenerateKey` function refers to [step 8 of the `generateKey` algorithm from the specification](https://www.w3.org/TR/WebCryptoAPI/#SubtleCrypto-method-generateKey).

Following this convention allows us to document why certain operations are made in a certain way, and to track the progress of the implementation. We do not always add them, but we try to do so when it makes sense, and encourage contributors to do the same.

0 comments on commit 9de2272

Please sign in to comment.