@lindorm/rsa 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.2.1](https://github.com/lindorm-io/monorepo/compare/@lindorm/rsa@0.2.0...@lindorm/rsa@0.2.1) (2025-07-02)
+
+**Note:** Version bump only for package @lindorm/rsa
+
 # [0.2.0](https://github.com/lindorm-io/monorepo/compare/@lindorm/rsa@0.1.9...@lindorm/rsa@0.2.0) (2025-06-17)
 
 ### Bug Fixes

package/README.md

@@ -1 +1,82 @@
 # @lindorm/rsa
+
+Lightweight **RSA signing / verification kit** that wraps a `RSxxx` key from
+[`@lindorm/kryptos`](../kryptos).  Provides a convenient `RsaKit` class that fulfils the `IKeyKit`
+contract used by the Lindorm crypto packages.
+
+---
+
+## Installation
+
+```bash
+npm install @lindorm/rsa
+# or
+yarn add @lindorm/rsa
+```
+
+Generate or import a key via Kryptos:
+
+```ts
+import { KryptosKit } from '@lindorm/kryptos';
+
+const RS256 = KryptosKit.generate.rsa({ alg: 'RS256', use: 'sig', modulusLength: 2048 });
+```
+
+---
+
+## Example
+
+```ts
+import { RsaKit } from '@lindorm/rsa';
+
+const kit = new RsaKit({ kryptos: RS256, encoding: 'base64url' });
+
+const signature = kit.sign('hello');
+
+kit.assert('hello', signature); // throws RsaError if invalid
+
+console.log(kit.format(signature)); // string representation
+```
+
+### DSA encoding
+
+Set `dsa: 'ieee-p1363'` when you need raw concatenated r||s encoding instead of DER:
+
+```ts
+const kit = new RsaKit({ kryptos: RS256, dsa: 'ieee-p1363' });
+```
+
+---
+
+## API
+
+```ts
+class RsaKit implements IKeyKit {
+  constructor(options: {
+    kryptos: IKryptosRsa;
+    dsa?: DsaEncoding;          // 'der' | 'ieee-p1363' (default 'der')
+    encoding?: BufferEncoding;  // default 'base64'
+  });
+
+  sign(data: KeyData): Buffer;
+  verify(data: KeyData, signature: KeyData): boolean;
+  assert(data: KeyData, signature: KeyData): void; // throws RsaError
+  format(buf: Buffer): string;                      // encode Buffer → string
+}
+```
+
+`KeyData` accepts `Buffer`, `string` or `Uint8Array`.
+
+---
+
+## TypeScript
+
+Written in TS; declaration files included. Runtime dependencies are limited to Node’s `crypto`
+module plus Lindorm utilities.
+
+---
+
+## License
+
+AGPL-3.0-or-later – see the root [`LICENSE`](../../LICENSE).
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lindorm/rsa",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "license": "AGPL-3.0-or-later",
   "author": "Jonn Nilsson",
   "repository": {
@@ -29,12 +29,12 @@
     "update:auto": "ncu -u"
   },
   "dependencies": {
-    "@lindorm/errors": "^0.1.8",
+    "@lindorm/errors": "^0.1.9",
     "@lindorm/is": "^0.1.8",
-    "@lindorm/kryptos": "^0.4.0"
+    "@lindorm/kryptos": "^0.4.1"
   },
   "devDependencies": {
     "@lindorm/types": "^0.3.0"
   },
-  "gitHead": "c1800f039a816f7ebce30379f8dce9c53ea9f5d1"
+  "gitHead": "e66150efb6d7a4688bcece59481ab98d54865af3"
 }