thingy-crypto-node 0.0.1 → 0.1.0

package/README.md

@@ -1,57 +1,102 @@
 # thingy-crypto-node 
 
 # Background
-Thingy Nodes usually have an assymetric keypair - this way all authentication works between the nodes in the thingy-ecosystem.
+Thingy Nodes usually have an asymmetric keypair - this way all authentication works between the nodes in the thingy-ecosystem.
 The thingy-crypto-node is the keeper of the keypair of this node - implementing all basic crypto functionality for this specific keypair.
 
+It is a convenience layer over [secret-manager-crypto-utils](https://www.npmjs.com/package/secret-manager-crypto-utils) - see there for the cryptographic details and security notes.
+
 # Usage
-Current Functionality
----------------------
-```coffescript
+```js
 import { ThingyCryptoNode } from "thingy-crypto-node"
 
-options = {
-    secretKeyHex: "..." # required
-    publicKeyHex: "..." # required
-    context: "..." # optional
-}
-cryptoNode = new ThingyCryptoNode(options)
+const cryptoNode = new ThingyCryptoNode({
+    secretKeyHex: "...", // required
+    publicKeyHex: "...", // required
+    context: "..."       // optional, default "standard ThingyCryptoNode"
+})
+```
 
+## Signing and Verifying
+```js
+const signatureHex = await cryptoNode.sign(content) // content: string
 
-## Signing and Verifiying
-content = STRING
-signatureHex = await cryptoNode.sign(content)
-signatureHex = STRINGHEX
+const err = await cryptoNode.sigCheck(signatureHex, content)
+if (err) throw new Error(err) // "Invalid signature!" or "Malformed input!"
+// valid from here
+```
+**`sigCheck` resolves `undefined` when the signature is valid** and an error string when it is not. It never throws.
+So the check is `if (err)` - and a forgotten `await` fails closed, because a Promise is truthy.
 
-true = await cryptoNode.verify(signatureHex, content)
+`sigCheck` checks signatures of this node's own key.
 
 ## Encrypting and Decrypting
-content = STRING
-secretsObject = await cryptoNode.encrypt(content)
-secretsObject = { referencePointHex, encryptedContentHex }
-secretsObject = { STRINGHEX, STRINGHEX }
-
-content = await cryptoNode.decrypt(secretsObject)
-
-## DiffieHellman For shared secret with specific foreign node
-id = STRINGHEX64
-salt = STRING
-timestamp = NUMBER
-sharedSecretHex = await cryptoNode.diffieHellmanFor(id, salt, timestamp)
-sharedSecretHex = STRINGHEX128
-
+Encrypts for this node's own key - e.g. for storing secrets only this node can read.
+```js
+const secretsObject = await cryptoNode.encrypt(content) // { referencePointHex, encryptedContentHex }
+const content = await cryptoNode.decrypt(secretsObject)
+```
+`decrypt` rejects with `Error("Decryption failed!")` on a wrong key or changed data.
+
+## Diffie-Hellman shared secret with a specific foreign node
+```js
+const sharedSecretHex = await cryptoNode.diffieHellmanFor(id, salt, timestamp)
+// id: the other node's publicKeyHex
+// salt: string, timestamp: number
+// sharedSecretHex: 128 hex chars (64 bytes)
+```
+Both nodes get the same secret when they use the same `salt`, `timestamp` and `context`.
+
+# Breaking Updates
+
+`0.0.x` -> `0.1.y`
+------------------
+Updated to secret-manager-crypto-utils 0.4 - new encryption format and new shared secrets.
+
+| 0.0.x | 0.1.x | What changed |
+|---|---|---|
+| `sign` | `sign` | nothing - same signatures |
+| `verify` → `true` when valid | `sigCheck` → `undefined` when valid | **removed, inverted meaning** - see below |
+| `encrypt` | `encrypt` | new format, 0.0.x cannot decrypt it |
+| `decrypt` | `decrypt` | reads the new format only |
+| `diffieHellmanFor` | `diffieHellmanFor` | different secret than 0.0.x |
+
+- `verify` is removed on purpose, so every old call fails loudly with `TypeError: cryptoNode.verify is not a function` - instead of silently accepting invalid signatures. Mind the inverted meaning:
+  ```js
+  // before
+  if (!(await cryptoNode.verify(sig, content))) return reject()
+  // now
+  if (await cryptoNode.sigCheck(sig, content)) return reject()
+  ```
+- Signatures are compatible both ways: 0.0.x nodes verify signatures of 0.1.x nodes and vice versa.
+
+## Legacy functions
+**Only for compatibility with data and nodes of 0.0.x. Never use them in new code. They will be removed in a future version.**
+
+| Function | 1:1 like 0.0.x | Use for |
+|---|---|---|
+| `verifyLegacy(sig, content)` | `verify` → `true` when valid (malformed input → `false` instead of throwing) | a quick fix until you switch to `sigCheck` |
+| `decryptLegacy(secretsObject)` | `decrypt` | reading data encrypted with 0.0.x -> encrypting it in new format is recommended |
+| `diffieHellmanForLegacy(id, salt, timestamp)` | `diffieHellmanFor` | nodes that still run 0.0.x shared secrets |
+
+Migrating encrypted data:
+```js
+let content
+try { content = await cryptoNode.decrypt(secretsObject) }
+catch { content = await cryptoNode.decryptLegacy(secretsObject) }
+secretsObject = await cryptoNode.encrypt(content) // store this one
 ```
 
----
-
-# Further steps
-
-- Add more features when the requirement pops up.
-
-
-All sorts of inputs are welcome, thanks!
+Talking to a node that still runs 0.0.x:
+```js
+const sharedSecretHex = peerIsLegacy
+    ? await cryptoNode.diffieHellmanForLegacy(id, salt, timestamp)
+    : await cryptoNode.diffieHellmanFor(id, salt, timestamp)
+```
+There is no way to detect a legacy node from the secret itself: you have to know which version the other node runs.
+Anything that was keyed with an old shared secret has to be re-derived.
 
 ---
 
 # License
-[Unlicense JhonnyJason style](https://hackmd.io/nCpLO3gxRlSmKVG3Zxy2hA?view)
+[CC0](https://creativecommons.org/publicdomain/zero/1.0/)

package/index.js

@@ -1,44 +1,30 @@
-// Generated by CoffeeScript 2.7.0
-//###########################################################
-var defaultContext;
+import * as secUtl from "secret-manager-crypto-utils"
+import * as legacy from "secret-manager-crypto-utils/legacy"
 
-import * as secUtl from "secret-manager-crypto-utils";
+const defaultContext = "standard ThingyCryptoNode"
 
-//###########################################################
-defaultContext = "standard ThingyCryptoNode";
-
-//###########################################################
-export var ThingyCryptoNode = class ThingyCryptoNode {
-  constructor(o) {
-    this.key = o.secretKeyHex;
-    this.id = o.publicKeyHex;
-    this.ctx = o.context;
-    if (this.ctx == null) {
-      this.ctx = defaultContext;
+export class ThingyCryptoNode {
+    constructor(o) {
+        this.key = o.secretKeyHex
+        this.id = o.publicKeyHex
+        this.ctx = o.context ?? defaultContext
     }
-  }
-
-  //#######################################################
-  async sign(content) {
-    return (await secUtl.createSignatureHex(content, this.key));
-  }
-
-  async verify(sig, content) {
-    return (await secUtl.verifyHex(sig, this.id, content));
-  }
 
-  async encrypt(content) {
-    return (await secUtl.asymmetricEncryptHex(content, this.id));
-  }
-
-  async decrypt(secretsObj) {
-    return (await secUtl.asymmetricDecryptHex(secretsObj, this.key));
-  }
+    sign(content) { return secUtl.createSignature(content, this.key) }
+    // undefined when valid, an error string otherwise - never throws
+    sigCheck(sig, content) { return secUtl.verifySignature(sig, this.id, content) }
+    encrypt(content) { return secUtl.asymmetricEncrypt(content, this.id) }
+    decrypt(secretsObj) { return secUtl.asymmetricDecrypt(secretsObj, this.key) }
+    diffieHellmanFor(id, salt, timestamp) {
+        return secUtl.diffieHellmanSecretHash(this.key, id, contextFor(salt, this.ctx, timestamp))
+    }
 
-  async diffieHellmanFor(id, salt, timestamp) {
-    var context;
-    context = `${salt}:${this.ctx}_${timestamp}`;
-    return (await secUtl.diffieHellmanSecretHashHex(this.key, id, context));
-  }
+    // Legacy: 1:1 with thingy-crypto-node 0.0.x - only for compatibility, will be removed
+    async verifyLegacy(sig, content) { return !(await this.sigCheck(sig, content)) }
+    decryptLegacy(secretsObj) { return legacy.asymmetricDecryptV0_3_1(secretsObj, this.key) }
+    diffieHellmanForLegacy(id, salt, timestamp) {
+        return legacy.diffieHellmanSecretHashV0_3_1(this.key, id, contextFor(salt, this.ctx, timestamp))
+    }
+}
 
-};
+const contextFor = (salt, ctx, timestamp) => `${salt}:${ctx}_${timestamp}`

package/package.json

@@ -1,14 +1,22 @@
 {
   "name": "thingy-crypto-node",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "The thingy-crypto-node is the keeper of an ed25519 keypair, implementing all basic crypto functionality for this specific keypair",
   "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": ["thingy", "crypto", "encryption", "signature", "ed25519", "el-gamal","diffie-hellman"],
+  "files": [
+    "index.js"
+  ],
+  "keywords": [
+    "thingy",
+    "crypto",
+    "encryption",
+    "signature",
+    "ed25519",
+    "el-gamal",
+    "diffie-hellman"
+  ],
   "author": "Lenard Frommelt lenard@frommelt.dev",
-  "license": "Unlicense",
+  "license": "CC0-1.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/JhonnyJason/thingy-crypto-node.git"
@@ -18,7 +26,13 @@
   },
   "homepage": "https://github.com/JhonnyJason/thingy-crypto-node-output#readme",
   "dependencies": {
-    "secret-manager-crypto-utils": "^0.3.0"
+    "secret-manager-crypto-utils": "^0.4.0"
   },
-  "type": "module"
+  "type": "module",
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
 }

package/LICENSE

@@ -1,9 +0,0 @@
-This is free and unencumbered software released into the public domain.
-Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
-
-In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and 
-successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <http://unlicense.org/>

package/unbreaker.js

@@ -1,4 +0,0 @@
-// Generated by LiveScript 1.6.0
-(function(){
-
-}).call(this);