salty-crypto 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +24 -21
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -19,27 +19,30 @@ Includes (and passes) test vectors from [noise-c](https://github.com/rweather/no
19
19
 
20
20
  ## Code overview
21
21
 
22
- - `src` directory:
23
- - [`aead.ts`](src/aead.ts): RFC-8439 ("IETF") ChaCha20-Poly1305 AEAD construction
24
- - [`blake2.ts`](src/blake2.ts): RFC-7693 BLAKE2s hash function
25
- - [`chacha20.ts`](src/chacha20.ts): RFC-8439 ("IETF") ChaCha20 cipher
26
- - [`noise.ts`](src/noise.ts): Core Noise Protocol Framework handshake and CipherState
27
- implementation
28
- - [`patterns.ts`](src/patterns.ts): Library of Noise handshake patterns
29
- - [`poly1305.ts`](src/poly1305.ts): Port of [the Poly1305 MAC implementation from
30
- tweetnacl.js](https://github.com/dchest/tweetnacl-js/blob/6a9594a35a27f9c723c5f1c107e376d1c65c23b3/nacl-fast.js#L462-L817),
31
- which in turn ported [Andrew Moon's Poly1305-donna-16
32
- code](https://github.com/floodyberry/poly1305-donna/blob/e6ad6e091d30d7f4ec2d4f978be1fcfcbce72781/poly1305-donna-16.h).
33
- - [`profiles.ts`](src/profiles.ts): Profiles of the Noise Protocol Framework. Currently
34
- just `Noise_25519_ChaChaPoly_BLAKE2s`.
35
- - [`random.ts`](src/random.ts): Port of [the randomness-generation code from
36
- tweetnacl.js](https://github.com/dchest/tweetnacl-js/blob/6a9594a35a27f9c723c5f1c107e376d1c65c23b3/nacl-fast.js#L2363-L2389).
37
- - [`x25519.ts`](src/x25519.ts): Port of [the X25519 key agreement implementation from
38
- tweetnacl.js](https://github.com/dchest/tweetnacl-js/blob/6a9594a35a27f9c723c5f1c107e376d1c65c23b3/nacl-fast.js#L852-L1379).
39
- - `test-vectors` directory: Contains Noise test vectors (more-or-less in the [standard JSON
40
- format](https://github.com/noiseprotocol/noise_wiki/wiki/Test-vectors)) copied from other
41
- projects.
42
- - `test` directory: Contains a test driver and test code.
22
+ - [`src/index.ts`](src/index.ts): Main package entrypoint; main API.
23
+ - [`src/aead.ts`](src/aead.ts): Abstract AEAD API.
24
+ - [`src/aead/chacha20poly1305.ts`](src/aead/chacha20poly1305.ts): RFC-8439 ("IETF") ChaCha20-Poly1305 AEAD construction.
25
+ - [`src/bytes.ts`](src/bytes.ts): Uint8Array utilities.
26
+ - [`src/cipher.ts`](src/cipher.ts): Abstract stream-cipher API.
27
+ - [`src/cipher/chacha20.ts`](src/cipher/chacha20.ts): RFC-8439 ("IETF") ChaCha20 cipher.
28
+ - [`src/dh.ts`](src/dh.ts): Abstract key agreement API.
29
+ - [`src/dh/x25519.ts`](src/dh/x25519.ts): Port of [the X25519 key agreement implementation from tweetnacl.js](https://github.com/dchest/tweetnacl-js/blob/6a9594a35a27f9c723c5f1c107e376d1c65c23b3/nacl-fast.js#L852-L1379).
30
+ - [`src/hash.ts`](src/hash.ts): Abstract hash-function API.
31
+ - [`src/hash/blake2s.ts`](src/hash/blake2s.ts): RFC-7693 BLAKE2s hash function.
32
+ - [`src/hash/poly1305.ts`](src/hash/poly1305.ts): Port of [the Poly1305 MAC implementation from tweetnacl.js](https://github.com/dchest/tweetnacl-js/blob/6a9594a35a27f9c723c5f1c107e376d1c65c23b3/nacl-fast.js#L462-L817), which in turn ported [Andrew Moon's Poly1305-donna-16 code](https://github.com/floodyberry/poly1305-donna/blob/e6ad6e091d30d7f4ec2d4f978be1fcfcbce72781/poly1305-donna-16.h).
33
+ - [`src/hkdf.ts`](src/hkdf.ts): Standard HKDF construction.
34
+ - [`src/hmac.ts`](src/hmac.ts): Standard HMAC construction.
35
+ - [`src/noise.ts`](src/noise.ts): Main Noise Protocol API.
36
+ - [`src/noise/algorithms.ts`](src/noise/algorithms.ts): Abstract Noise algorithms API.
37
+ - [`src/noise/cipherstate.ts`](src/noise/cipherstate.ts): Noise Protocol CipherState implementation.
38
+ - [`src/noise/handshake.ts`](src/noise/handshake.ts): Core Noise Protocol Framework handshake implementation.
39
+ - [`src/noise/patterns.ts`](src/noise/patterns.ts): Library of Noise handshake patterns.
40
+ - [`src/noise/profiles.ts`](src/noise/profiles.ts): Profiles of the Noise Protocol Framework. Currently just `Noise_25519_ChaChaPoly_BLAKE2s`.
41
+ - [`src/noise/rekey.ts`](src/noise/rekey.ts): Noise Protocol default rekey function.
42
+ - [`src/nonce.ts`](src/nonce.ts): Representation of 64- (or 96-) bit nonces.
43
+ - [`src/random.ts`](src/random.ts): Port of [the randomness-generation code from tweetnacl.js](https://github.com/dchest/tweetnacl-js/blob/6a9594a35a27f9c723c5f1c107e376d1c65c23b3/nacl-fast.js#L2363-L2389).
44
+ - [`test-vectors`](test-vectors): Contains Noise test vectors (more-or-less in the [standard JSON format](https://github.com/noiseprotocol/noise_wiki/wiki/Test-vectors)) copied from other projects.
45
+ - [`test`](test): Contains a test driver and test code.
43
46
 
44
47
  ## Copyright and License
45
48
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "salty-crypto",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Noise Protocol Framework, plus X25519/ChaCha20Poly1305/BLAKE2s code, for browser and node.js",
5
5
  "author": "Tony Garnock-Jones <tonyg@leastfixedpoint.com>",
6
6
  "homepage": "https://github.com/tonyg/typescript-salty-crypto",