@keetanetwork/anchor 0.0.38 → 0.0.39

package/lib/encrypted-container.d.ts

@@ -1,7 +1,42 @@
 import { lib as KeetaNetLib } from '@keetanetwork/keetanet-client';
 import { Buffer } from './utils/buffer.js';
+import { KeetaAnchorError } from './error.js';
+/**
+ * Error codes for EncryptedContainer operations
+ */
+export declare const EncryptedContainerErrorCodes: readonly ["MALFORMED_BASE_FORMAT", "MALFORMED_VERSION", "MALFORMED_DATA_STRUCTURE", "MALFORMED_KEY_INFO", "MALFORMED_SIGNER_INFO", "UNSUPPORTED_VERSION", "UNSUPPORTED_CIPHER_ALGORITHM", "UNSUPPORTED_DIGEST_ALGORITHM", "UNSUPPORTED_SIGNATURE_ALGORITHM", "UNSUPPORTED_KEY_TYPE", "NO_KEYS_PROVIDED", "NO_MATCHING_KEY", "DECRYPTION_FAILED", "DECOMPRESSION_FAILED", "SIGNER_REQUIRES_PRIVATE_KEY", "NOT_SIGNED", "SIGNATURE_VERIFICATION_FAILED", "NO_PLAINTEXT_AVAILABLE", "NO_ENCODED_DATA_AVAILABLE", "PLAINTEXT_DISABLED", "ENCRYPTION_REQUIRED", "INVALID_PRINCIPALS", "ACCESS_MANAGEMENT_NOT_ALLOWED", "INTERNAL_ERROR"];
+/**
+ * Error code type
+ */
+export type EncryptedContainerErrorCode = typeof EncryptedContainerErrorCodes[number];
+/**
+ * Error class for EncryptedContainer operations
+ */
+export declare class EncryptedContainerError extends KeetaAnchorError {
+    static readonly name: string;
+    private readonly encryptedContainerErrorObjectTypeID;
+    private static readonly encryptedContainerErrorObjectTypeID;
+    readonly code: EncryptedContainerErrorCode;
+    /**
+     * Check if a string is a valid EncryptedContainerErrorCode
+     */
+    static isValidCode(code: string): code is EncryptedContainerErrorCode;
+    constructor(code: EncryptedContainerErrorCode, message: string);
+    static isInstance(input: unknown): input is EncryptedContainerError;
+    toJSON(): ReturnType<KeetaAnchorError['toJSON']> & {
+        code: EncryptedContainerErrorCode;
+    };
+    static fromJSON(input: unknown): Promise<EncryptedContainerError>;
+}
 declare const Account: typeof KeetaNetLib.Account;
 type Account = InstanceType<typeof KeetaNetLib.Account>;
+/**
+ * Options for creating an EncryptedContainer from plaintext
+ */
+export type FromPlaintextOptions = {
+    locked?: boolean;
+    signer?: Account;
+};
 type CipherOptions = {
     /**
      * The symmetric cipher key (if any)
@@ -35,7 +70,7 @@ export declare class EncryptedContainer {
      * Encryption details
      */
     protected _internalState: EncryptedContainerInfo | UnencryptedContainerInfo;
-    constructor(principals: Account[] | null);
+    constructor(principals: Account[] | null, signer?: Account);
     get encrypted(): boolean;
     /**
      * Create an instance of the EncryptedContainer from an encrypted blob,
@@ -54,10 +89,10 @@ export declare class EncryptedContainer {
      *
      * @param data The plaintext data to encrypt or encode
      * @param principals The list of principals who can access the data if it is null then the data is not encrypted
-     * @param locked If true, the plaintext data will not be accessible from this instance; otherwise it will be -- default depends on principals
+     * @param options Options including locked (plaintext accessibility) and signer (for RFC 5652 signing). For backward compatibility, can also be a boolean for locked.
      * @returns The EncryptedContainer instance with the plaintext data and principals set
      */
-    static fromPlaintext(data: string | ArrayBuffer | Buffer, principals: Account[] | null, locked?: boolean): EncryptedContainer;
+    static fromPlaintext(data: string | ArrayBuffer | Buffer, principals: Account[] | null, options?: boolean | FromPlaintextOptions): EncryptedContainer;
     /**
      * Set the plaintext buffer to the specified value
      */
@@ -101,6 +136,21 @@ export declare class EncryptedContainer {
      * this container
      */
     get principals(): Account[];
+    /**
+     * Check if this container is signed
+     */
+    get isSigned(): boolean;
+    /**
+     * Get the signing account of this container.
+     */
+    getSigningAccount(): Account | undefined;
+    /**
+     * Verify the signature on this container.
+     * This requires decrypting the container first to access the compressed plaintext.
+     *
+     * @returns true if signature is valid, false if invalid, or throws if not signed or plaintext unavailable
+     */
+    verifySignature(): Promise<boolean>;
 }
 export default EncryptedContainer;
 //# sourceMappingURL=encrypted-container.d.ts.map

package/lib/encrypted-container.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encrypted-container.d.ts","sourceRoot":"","sources":["../../src/lib/encrypted-container.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,IAAI,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAKnE,OAAO,EAAE,MAAM,EAA4C,MAAM,mBAAmB,CAAC;AAOrF,QAAA,MAAM,OAAO,EAAE,OAAO,WAAW,CAAC,OAA6B,CAAC;AAChE,KAAK,OAAO,GAAG,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;AAyFxD,KAAK,aAAa,GAAG;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACnB,CAAA;AAkUD,KAAK,sBAAsB,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG;IACjE;;OAEG;IACH,UAAU,EAAE,OAAO,EAAE,CAAC;CACtB,CAAA;AAED,KAAK,wBAAwB,GAAG;IAC/B;;OAEG;IACH,UAAU,EAAE,IAAI,CAAC;CACjB,CAAA;AAED,qBAAa,kBAAkB;;IAC9B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAOlD;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,sBAAsB,GAAG,wBAAwB,CAAC;gBAUhE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI;IAcxC,IAAI,SAAS,IAAI,OAAO,CAEvB;IAMD;;;;;;;OAOG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,kBAAkB;IASjG,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,GAAG,kBAAkB;IAStG;;;;;;;;;OASG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,kBAAkB;IAmB7H;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,IAAI;IAWvD,OAAO,KAAK,QAAQ,GAMnB;IAED,OAAO,KAAK,UAAU,GAMrB;IA8JD;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,IAAI;IAqBpD;;OAEG;IACG,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/D;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAmBxC;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAmB1C;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,WAAW,CAAC;IAe9C;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,EAAE,CAM1B;CACD;AAQD,eAAe,kBAAkB,CAAC"}
+{"version":3,"file":"encrypted-container.d.ts","sourceRoot":"","sources":["../../src/lib/encrypted-container.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,IAAI,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAKnE,OAAO,EAAE,MAAM,EAAqE,MAAM,mBAAmB,CAAC;AAE9G,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAI9C;;GAEG;AACH,eAAO,MAAM,4BAA4B,qmBAsC/B,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,4BAA4B,CAAC,MAAM,CAAC,CAAC;AAEtF;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC5D,gBAAyB,IAAI,EAAE,MAAM,CAA6B;IAElE,OAAO,CAAC,QAAQ,CAAC,mCAAmC,CAAU;IAC9D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,mCAAmC,CAA0C;IAErG,QAAQ,CAAC,IAAI,EAAE,2BAA2B,CAAC;IAE3C;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,2BAA2B;gBAKzD,IAAI,EAAE,2BAA2B,EAAE,OAAO,EAAE,MAAM;IAY9D,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,uBAAuB;IAI1D,MAAM,IAAI,UAAU,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,2BAA2B,CAAA;KAAE;WAOpF,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAkBvE;AAQD,QAAA,MAAM,OAAO,EAAE,OAAO,WAAW,CAAC,OAA6B,CAAC;AAChE,KAAK,OAAO,GAAG,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAClC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAmRF,KAAK,aAAa,GAAG;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACnB,CAAA;AA+bD,KAAK,sBAAsB,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG;IACjE;;OAEG;IACH,UAAU,EAAE,OAAO,EAAE,CAAC;CACtB,CAAA;AAED,KAAK,wBAAwB,GAAG;IAC/B;;OAEG;IACH,UAAU,EAAE,IAAI,CAAC;CACjB,CAAA;AAcD,qBAAa,kBAAkB;;IAC9B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAOlD;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,sBAAsB,GAAG,wBAAwB,CAAC;gBAehE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,OAAO;IAkB1D,IAAI,SAAS,IAAI,OAAO,CAEvB;IAMD;;;;;;;OAOG;IACH,MAAM,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,kBAAkB;IASjG,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,GAAG,kBAAkB;IAStG;;;;;;;;;OASG;IACH,MAAM,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,oBAAoB,GAAG,kBAAkB;IA+BrJ;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,IAAI;IAWvD,OAAO,KAAK,QAAQ,GAMnB;IAED,OAAO,KAAK,UAAU,GAMrB;IA8KD;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,IAAI;IAqBpD;;OAEG;IACG,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ/D;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAmBxC;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAmB1C;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,WAAW,CAAC;IAe9C;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,EAAE,CAM1B;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;OAEG;IACH,iBAAiB,IAAI,OAAO,GAAG,SAAS;IAexC;;;;;OAKG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;CA2DzC;AAQD,eAAe,kBAAkB,CAAC"}