Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
secret-handshake
Advanced tools
secret-handshake - npm Package Compare versions
Comparing version 1.1.20 to 1.1.21
| { | ||
| "name": "secret-handshake", | ||
| "description": "a simple and highly private secure-channel protocol", | ||
| "version": "1.1.20", | ||
| "homepage": "https://github.com/dominictarr/secret-handshake", | ||
| "version": "1.1.21", | ||
| "homepage": "https://github.com/auditdrivencrypto/secret-handshake", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git://github.com/dominictarr/secret-handshake.git" | ||
| "url": "git://github.com/auditdrivencrypto/secret-handshake.git" | ||
| }, | ||
| "scripts": { | ||
| "prepublishOnly": "npm ls && npm test", | ||
| "test": "npm-run-all test:original test:shs1-test", | ||
| "test:original": "set -e; for t in test/*.js; do node $t; done", | ||
| "test:shs1-test": "npm-run-all test:shs1-test:*", | ||
| "test:shs1-test:server": "shs1testserver test/shs1-test/server.js", | ||
| "test:shs1-test:client": "shs1testclient test/shs1-test/client.js" | ||
| }, | ||
| "files": [ | ||
| "*.js" | ||
| ], | ||
| "dependencies": { | ||
| "chloride": "^2.2.8", | ||
| "explain-error": "^1.0.4", | ||
| "clarify-error": "^1.0.0", | ||
| "pull-box-stream": "^1.0.13", | ||
@@ -36,3 +31,11 @@ "pull-handshake": "^1.1.1", | ||
| "author": "Dominic Tarr <dominic.tarr@gmail.com> (http://dominictarr.com)", | ||
| "license": "MIT" | ||
| } | ||
| "license": "MIT", | ||
| "scripts": { | ||
| "test": "npm-run-all test:original test:shs1-test", | ||
| "test:original": "set -e; for t in test/*.js; do node $t; done", | ||
| "test:shs1-test": "npm-run-all test:shs1-test:*", | ||
| "test:shs1-test:server": "shs1testserver test/shs1-test/server.js", | ||
| "test:shs1-test:client": "shs1testclient test/shs1-test/client.js" | ||
| }, | ||
| "readme": "# secret-handshake\n\nsecure-channel based on a a mutually authenticating key agreement handshake, with forward secure identity metadata.\n\nFor a full explanation of the design, read the\n[Design Paper](http://dominictarr.github.io/secret-handshake-paper/shs.pdf)\n\n## Implementations\n\n* javascript/node.js this repo.\n* go [cryptix/secretstream](https://github.com/cryptix/secretstream/)\n* rust [AljoschaMeyer/secret-handshake-rs](https://github.com/AljoschaMeyer/secret-handshake-rs)\n* c [AljoschaMeyer/shs1-c](https://github.com/AljoschaMeyer/shs1-c) (actually just implements the crypto, not the protocol used as a component in the rust implementation)\n* python/twisted [david415/txsecrethandshake](https://github.com/david415/txsecrethandshake) (WIP)\n* C++ [Kodest/cppshs](https://github.com/Kodest/cppshs) (WIP)\n* also [keks/tamarin-shs](https://github.com/keks/tamarin-shs) is a formal proof of the cryptographic properties!\n\n## Claims\n\nThis protocol derives shared keys and mutually\nauthenticates both ends of the connection.\nThe shared secrets are forward secure, and\nso is the identity metadata.\n\nby \"forward secure identity metadata\" I mean:\n\n* a later key compromise cannot confirm the public keys in the handshake.\n\nAnd also:\n\n* an eavesdropper cannot learn public keys\n* replay attacker cannot learn public keys.\n* man in the middle cannot learn public keys.\n* a \"wrong number\" cannot learn public keys.\n* an unauthenticated client cannot learn server key.\n \n> note: a wrong number is just an accidental man in the middle.\n\nBy \"confirm\" I mean check a guess at the public key.\nBy \"learn\" I mean that you can _either_ extract the public key,\nor confirm the public key.\n\nAlso note that if the server decides not to authenticate a client,\nit will learn their public key. To get to this stage, the client\nmust know the server's key, so now the client and server both\nknow each others key. This is fair.\n\n## Disclaims\n\nThis protocol cannot hide your ip address.\nThis protocol does not attempt to obscure packet boundries.\nIf a man in the middle or wrong number later compromises\nthe server's key, they will be able to extract the client\nkey from the client's hello packet.\n\n## Example\n\n``` js\nvar SHS = require('secret-handshake')\n\nvar cl = require('chloride')\nvar appKey = ... //32 random bytes\nvar alice = cl.crypto_sign_keypair() //client\nvar bob = cl.crypto_sign_keypair() //server\n\nfunction authorize(id, cb) {\n cb(null, check(id)) //check wether id is authorized.\n}\n\n//initialize, with default timeouts.\nvar ServerStream = SHS.createServer(alice, authorize, appKey)\nvar ClientStream = SHS.createClient(bob, appkey)\n\nvar alice_stream = ServerStream(function (err, stream) {\n ...\n})\n\nvar bob_stream = ClientStream(alice.publicKey, function (err, stream) {\n ...\n})\n\n//simulate a streaming network connection by connecting streams together\npull(alice_stream, bob_stream, alice_stream)\n```\n\n## Notes\n\nI recommend using secret-handshake via [multiserver](https://github.com/dominictarr/multiserver)\n\n[pull-streams](https://github.com/dominictarr/pull-streams) are used.\nLearn about how pull-streams from [these examples](https://github.com/dominictarr/pull-stream-examples)\n\nKeypairs are expected to be of the form [sodium](https://github.com/paixaop/node-sodium) produces.\n[chloride](https://github.com/dominictarr/chloride) is my fork of this and is compatible.\n\nIf you're interested in the protocol, you can read more here : https://ssbc.github.io/scuttlebutt-protocol-guide/#handshake\n\n## api\n\n### createClient(keypair, authorize, appkey, timeout) => createClientStream(key, seed?, cb(err, plainstream)) => cipherstream\n\n`createClient` takes: \n- `keypair` - a keypair of form `{ secretKey, publicKey }` - your clients keys (see `chloride#crypto_sign_keypair`)\n- `appkey` - the network identifier, 32 random bytes\n- `timeout` - an integer (in milliseconds? CHECK THIS)\n\nand returns a `createClientStream`\n\n`createClientStream` takes a the public `key` for the remote peer,\nan optional `seed` (which is used to generate a one-time private key),\nand a callback, `cb`. `cipherstream`, an encrypted duplex pull-stream is returned.\n\nOnce the stream is connected to a server stream,\nsecret-handshake will attempt to authorize, and will call\n`cb` with an `err` if it fails, or `plainstream` if it succeeds.\nIf `keypair` is null, `seed` *must* be provided.\n\n### createServer(keypair, authorize(id, cb), appkey, timeout) => createServerStream(cb(err, plain_stream)) => cipherstream\n\n`createServer` is similar, except it takes `authorize`,\n- `keypair` - a keypair of form `{ secretKey, publicKey }` (see `chloride#crypto_sign_keypair`)\n- `authorize` - an async function of signature `(id, cb)` that decides whether a client with id == publicKey is allowed to continue with handshake\n- `appkey` - the network identifier, 32 random bytes\n- `timeout` - an integer (in milliseconds? CHECK THIS)\n\nA stream constructor function is returned\nNote the server DOES NOT take the client id as an argument - instead, in the process\nof the handshake, the server learns the `id`, and passes it to `authorize`.\nIf `authorize` calls back truthy, then it will callback `cb(null, plainstream)`\nelse it errors, `cb(err)`.\nThe value that `authorize` calls back `cb(null, <V>)` will be assigned to `plainstream.auth = <V>`.\nAlso, the `id` of the remote will be assigned to `plainstream.id`.\nThis way the application layer can know who it's peer is.\n\n## License\n\nMIT\n" | ||
| } |
| 'use strict' | ||
| var pull = require('pull-stream') | ||
| var boxes = require('pull-box-stream') | ||
| var explain = require('explain-error') | ||
| var clarify = require('clarify-error') | ||
| var errors = require('./errors') | ||
@@ -23,3 +23,3 @@ var Handshake = require('pull-handshake') | ||
| //alice may be null. | ||
| //alice may be null, e.g. https://github.com/ssbc/ssb-invite/blob/b93918b3e6adcb8dd68674fdbb270b49ff07f2a8/index.js#L219 | ||
| var state = stateless.initialize({ | ||
@@ -38,3 +38,3 @@ app_key: app_key, | ||
| function abort(err, reason) { | ||
| if(err && err !== true) shake.abort(explain(err, reason), cb) | ||
| if(err && err !== true) shake.abort(clarify(err, reason), cb) | ||
| else shake.abort(new Error(reason), cb) | ||
@@ -41,0 +41,0 @@ } |
@@ -15,3 +15,2 @@ # secret-handshake | ||
| * python/twisted [david415/txsecrethandshake](https://github.com/david415/txsecrethandshake) (WIP) | ||
| * C [Kodest/cshs](https://github.com/Kodest/cshs) | ||
| * C++ [Kodest/cppshs](https://github.com/Kodest/cppshs) (WIP) | ||
@@ -18,0 +17,0 @@ * also [keks/tamarin-shs](https://github.com/keks/tamarin-shs) is a formal proof of the cryptographic properties! |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-35.58%
26464
- Number of package files
- decreased by-52.94%
8
- Lines of code
- decreased by-67.79%
324
- Number of lines in readme file
- decreased by-0.72%
138
Dependency changes
+ Addedclarify-error@^1.0.0
+ Addedclarify-error@1.0.0(transitive)
- Removedexplain-error@^1.0.4
- Removedexplain-error@1.0.4(transitive)