@lifeready/core 1.0.2 → 1.0.3

package/lib/api/key-exchange.service.d.ts

@@ -1,39 +1,39 @@
-import { LifeReadyAuthService } from '../auth/life-ready-auth.service';
-import { EncryptionService } from '../cryptography/encryption.service';
-import { KeyService } from '../cryptography/key.service';
-import { UserService } from './../users/user.service';
-import { CompleteOtk, DecryptedKeyExchange, GetKeyExchangeListOptions, GetKeyExchangeOptions, InitiateOtkInput, KeyExchange, RespondOtk, RespondOtkInput, UserSharedKey } from './key-exchange.types';
-import { LrApolloService } from './lr-apollo.service';
-import { KeyFactoryService as KFS } from '../cryptography/key-factory.service';
-export declare class KeyExchangeService {
-    private keyFactory;
-    private keyService;
-    private lrApollo;
-    private encryptionService;
-    private authService;
-    private userService;
-    private readonly CLIENT_NONCE_LENGTH;
-    constructor(keyFactory: KFS, keyService: KeyService, lrApollo: LrApolloService, encryptionService: EncryptionService, authService: LifeReadyAuthService, userService: UserService);
-    getKeyExchangeList(input?: GetKeyExchangeListOptions): Promise<any>;
-    /**
-     * @param id If the current user can responder the key exchange if they are either the initiator or the receiver.
-     * @param token If not signed in, or not the initiator or responder, 'token' must be given.
-     * @param otKeyK Is the raw one-time key (string). If the responder is explicitly specified at time of initiation, then
-     *   it's possible to have the otKey wrapped by the public key of the responder. In which case, the otKeyK is not needed.
-     */
-    getKeyExchange(id: string, { otKeyK, token }?: GetKeyExchangeOptions): Promise<DecryptedKeyExchange>;
-    private decryptResponseCipher;
-    decryptKeyExchange(keyExchange: KeyExchange, otKeyK?: string): Promise<DecryptedKeyExchange>;
-    private decryptOtk;
-    private getOtKey;
-    initiateOtk({ message, email, contactCard, upgrade, }: InitiateOtkInput): Promise<{
-        keyExchange: KeyExchange;
-        otKeyK: string;
-    }>;
-    respondOtk({ id, token, decryptedOtk, message, initiatorContactCard, responderContactCard: sentContactCard, }: RespondOtkInput): Promise<RespondOtk>;
-    completeOtk(keyExchangeId: string, initiatorRootKeyCipher: string, initiatorOneTimePbkCipher: string, responderContactCard?: string): Promise<CompleteOtk>;
-    currentUserSharedKey(input: {
-        username?: string;
-        userId?: string;
-    }): Promise<UserSharedKey>;
-}
+import { LifeReadyAuthService } from '../auth/life-ready-auth.service';
+import { EncryptionService } from '../cryptography/encryption.service';
+import { KeyService } from '../cryptography/key.service';
+import { UserService } from './../users/user.service';
+import { CompleteOtk, DecryptedKeyExchange, GetKeyExchangeListOptions, GetKeyExchangeOptions, InitiateOtkInput, KeyExchange, RespondOtk, RespondOtkInput, UserSharedKey } from './key-exchange.types';
+import { LrApolloService } from './lr-apollo.service';
+import { KeyFactoryService as KFS } from '../cryptography/key-factory.service';
+export declare class KeyExchangeService {
+    private keyFactory;
+    private keyService;
+    private lrApollo;
+    private encryptionService;
+    private authService;
+    private userService;
+    private readonly CLIENT_NONCE_LENGTH;
+    constructor(keyFactory: KFS, keyService: KeyService, lrApollo: LrApolloService, encryptionService: EncryptionService, authService: LifeReadyAuthService, userService: UserService);
+    getKeyExchangeList(input?: GetKeyExchangeListOptions): Promise<any>;
+    /**
+     * @param id If the current user can responder the key exchange if they are either the initiator or the receiver.
+     * @param token If not signed in, or not the initiator or responder, 'token' must be given.
+     * @param otKeyK Is the raw one-time key (string). If the responder is explicitly specified at time of initiation, then
+     *   it's possible to have the otKey wrapped by the public key of the responder. In which case, the otKeyK is not needed.
+     */
+    getKeyExchange(id: string, { otKeyK, token }?: GetKeyExchangeOptions): Promise<DecryptedKeyExchange>;
+    private decryptResponseCipher;
+    decryptKeyExchange(keyExchange: KeyExchange, otKeyK?: string): Promise<DecryptedKeyExchange>;
+    private decryptOtk;
+    private getOtKey;
+    initiateOtk({ message, email, contactCard, upgrade, }: InitiateOtkInput): Promise<{
+        keyExchange: KeyExchange;
+        otKeyK: string;
+    }>;
+    respondOtk({ id, token, decryptedOtk, message, initiatorContactCard, responderContactCard: sentContactCard, }: RespondOtkInput): Promise<RespondOtk>;
+    completeOtk(keyExchangeId: string, initiatorRootKeyCipher: string, initiatorOneTimePbkCipher: string, responderContactCard?: string): Promise<CompleteOtk>;
+    currentUserSharedKey(input: {
+        username?: string;
+        userId?: string;
+    }): Promise<UserSharedKey>;
+}

package/lib/api/key-exchange.types.d.ts

@@ -1,196 +1,196 @@
-import { Key } from '../cryptography/cryptography.types';
-import { AccessLevel } from '../category/category.types';
-import { JWK } from 'node-jose';
-import { ContactCardName, TrustedPartyDetails } from '../users/profile.types';
-export interface PlainInitiatorRootKeyCipher {
-    nonce: string;
-    oneTimePrk: object;
-    otKey: object;
-    initiatorContactCard?: {
-        plainOwnerCipherDataJson: any;
-        plainSharedCipherDataJson: any;
-    };
-    initiator: {
-        message?: KeyExchangeMessage;
-        contactCard?: {
-            plainSharedCipherDataJson: TrustedPartyDetails;
-        };
-    };
-}
-export interface SharedContactCardInput {
-    plainCipherDataJson?: any;
-    plainSharedCipherDataJson?: any;
-    sharedCipherKey?: object;
-}
-export interface PreparedPermissions {
-    categories?: {
-        categoryId: string;
-        accessLevel: AccessLevel;
-    }[];
-    records?: {
-        recordId: string;
-        accessLevel: AccessLevel;
-    }[];
-}
-export interface KeyExchangeMessage {
-    name?: string;
-    email?: string;
-    message?: string;
-    permissions?: PreparedPermissions;
-}
-export interface PlainOtKeyCipher {
-    nonce: string;
-    initiator: {
-        oneTimePbk: object;
-        pbk: object;
-        sigPbk: object;
-        profile?: {
-            username?: string;
-        };
-        message?: KeyExchangeMessage;
-        contactCard?: {
-            plainSharedCipherDataJson: TrustedPartyDetails;
-        };
-    };
-}
-export interface DecryptedOtk {
-    plainOtKeyCipher: PlainOtKeyCipher;
-    otKey: JWK.Key;
-}
-export interface PlainInitiatorOneTimePbkCipher {
-    nonce: string;
-    sharedKey: object;
-    mkSharedKey: object;
-    responder: {
-        pbk: object;
-        sigPbk: object;
-        profile?: {
-            username?: string;
-        };
-        message?: KeyExchangeMessage;
-        contactCard?: {
-            plainSharedCipherDataJson: TrustedPartyDetails;
-            sharedCipherKey: object;
-        };
-    };
-}
-export declare enum OtkState {
-    OTK_INITIATED = "OTK_INITIATED",
-    OTK_ACCEPTED = "OTK_ACCEPTED",
-    OTK_COMPLETED = "OTK_COMPLETED"
-}
-export interface KeyExchangeContactCardInput {
-    ownerPlainData?: {
-        name: ContactCardName;
-    };
-    plainOwnerCipherDataJson: any;
-    plainSharedCipherDataJson: TrustedPartyDetails;
-}
-export interface InitiateOtkInput {
-    email?: string;
-    message?: KeyExchangeMessage;
-    contactCard?: KeyExchangeContactCardInput;
-    upgrade?: boolean;
-}
-export interface RespondOtkInput {
-    id: string;
-    token: string;
-    decryptedOtk: DecryptedOtk;
-    message?: KeyExchangeMessage;
-    initiatorContactCard?: {
-        plainReceiverCipherDataJson: any;
-    };
-    responderContactCard?: KeyExchangeContactCardInput;
-}
-export declare enum KeyExchangeState {
-    IN_PROGRESS = "IN_PROGRESS",
-    COMPLETED = "COMPLETED",
-    DECLINED = "DECLINED",
-    CANCELLED = "CANCELLED"
-}
-export declare enum KeyExchangeMode {
-    OTK = "OTK"
-}
-export interface Otk {
-    id: string;
-    state: OtkState;
-    otKeyParams: string;
-    otKeyCipher: string;
-    sharedKey: Key;
-    mkSharedKey: Key;
-    initiatorSigPxk: Key;
-    responderSigPxk: Key;
-    initiatorOneTimePbkCipher: string;
-    responderPbkCipher?: string;
-}
-export interface KeyExchange {
-    id: string;
-    state: KeyExchangeState;
-    mode: KeyExchangeMode;
-    created: string;
-    modified: string;
-    isInitiator: boolean;
-    initiator: {
-        id: string;
-        username: string;
-    };
-    responder: {
-        id: string;
-        username: string;
-    };
-    initiatorActionRequired?: boolean;
-    responderActionRequired?: boolean;
-    responderEmailAddress?: string;
-    token?: string;
-    tokenExpiryTime?: string;
-    isExpired?: boolean;
-    otk?: Otk;
-    initiatorRootKeyCipher: string;
-}
-export interface DecryptedKeyExchange extends KeyExchange {
-    decryptedOtk?: DecryptedOtk;
-    message?: KeyExchangeMessage;
-    contactCard?: TrustedPartyDetails;
-    myMessage?: KeyExchangeMessage;
-    myContactCard?: TrustedPartyDetails;
-}
-export interface GetKeyExchangeOptions {
-    otKeyK?: string;
-    token?: string;
-}
-export interface RespondOtk {
-    keyExchange: KeyExchange;
-    userSharedKey: UserSharedKey;
-    tp: {
-        id: string;
-    };
-}
-export interface CompleteOtk {
-    keyExchange: KeyExchange;
-    userSharedKey: UserSharedKey;
-    tp: {
-        id: string;
-    };
-}
-export interface UserSharedKey {
-    userSigPrk: Key;
-    sharedKey: Key;
-    mkSharedKey?: Key;
-    mkPxk?: Key;
-    mkReshareRequestCipher?: string;
-    mkReshareResponseCipher?: string;
-    mkReshareRequestSent?: boolean;
-    mkReshareResponseSent?: boolean;
-}
-export interface GetKeyExchangeListOptions {
-    orderBy?: 'created' | '-created' | 'modified' | '-modified' | 'expiry_time' | '-expiry_time';
-    isExpired?: boolean;
-    initiatorActionRequired?: boolean;
-    responderActionRequired?: boolean;
-    initiator?: string;
-    responder?: string;
-    state?: 'IN_PROGRESS' | 'COMPLETED' | 'DECLINED' | 'CANCELLED';
-}
-export interface PlainResponderPbkCipher {
-    otKey: object;
-}
+import { Key } from '../cryptography/cryptography.types';
+import { AccessLevel } from '../category/category.types';
+import { JWK } from 'node-jose';
+import { ContactCardName, TrustedPartyDetails } from '../users/profile.types';
+export interface PlainInitiatorRootKeyCipher {
+    nonce: string;
+    oneTimePrk: object;
+    otKey: object;
+    initiatorContactCard?: {
+        plainOwnerCipherDataJson: any;
+        plainSharedCipherDataJson: any;
+    };
+    initiator: {
+        message?: KeyExchangeMessage;
+        contactCard?: {
+            plainSharedCipherDataJson: TrustedPartyDetails;
+        };
+    };
+}
+export interface SharedContactCardInput {
+    plainCipherDataJson?: any;
+    plainSharedCipherDataJson?: any;
+    sharedCipherKey?: object;
+}
+export interface PreparedPermissions {
+    categories?: {
+        categoryId: string;
+        accessLevel: AccessLevel;
+    }[];
+    records?: {
+        recordId: string;
+        accessLevel: AccessLevel;
+    }[];
+}
+export interface KeyExchangeMessage {
+    name?: string;
+    email?: string;
+    message?: string;
+    permissions?: PreparedPermissions;
+}
+export interface PlainOtKeyCipher {
+    nonce: string;
+    initiator: {
+        oneTimePbk: object;
+        pbk: object;
+        sigPbk: object;
+        profile?: {
+            username?: string;
+        };
+        message?: KeyExchangeMessage;
+        contactCard?: {
+            plainSharedCipherDataJson: TrustedPartyDetails;
+        };
+    };
+}
+export interface DecryptedOtk {
+    plainOtKeyCipher: PlainOtKeyCipher;
+    otKey: JWK.Key;
+}
+export interface PlainInitiatorOneTimePbkCipher {
+    nonce: string;
+    sharedKey: object;
+    mkSharedKey: object;
+    responder: {
+        pbk: object;
+        sigPbk: object;
+        profile?: {
+            username?: string;
+        };
+        message?: KeyExchangeMessage;
+        contactCard?: {
+            plainSharedCipherDataJson: TrustedPartyDetails;
+            sharedCipherKey: object;
+        };
+    };
+}
+export declare enum OtkState {
+    OTK_INITIATED = "OTK_INITIATED",
+    OTK_ACCEPTED = "OTK_ACCEPTED",
+    OTK_COMPLETED = "OTK_COMPLETED"
+}
+export interface KeyExchangeContactCardInput {
+    ownerPlainData?: {
+        name: ContactCardName;
+    };
+    plainOwnerCipherDataJson: any;
+    plainSharedCipherDataJson: TrustedPartyDetails;
+}
+export interface InitiateOtkInput {
+    email?: string;
+    message?: KeyExchangeMessage;
+    contactCard?: KeyExchangeContactCardInput;
+    upgrade?: boolean;
+}
+export interface RespondOtkInput {
+    id: string;
+    token: string;
+    decryptedOtk: DecryptedOtk;
+    message?: KeyExchangeMessage;
+    initiatorContactCard?: {
+        plainReceiverCipherDataJson: any;
+    };
+    responderContactCard?: KeyExchangeContactCardInput;
+}
+export declare enum KeyExchangeState {
+    IN_PROGRESS = "IN_PROGRESS",
+    COMPLETED = "COMPLETED",
+    DECLINED = "DECLINED",
+    CANCELLED = "CANCELLED"
+}
+export declare enum KeyExchangeMode {
+    OTK = "OTK"
+}
+export interface Otk {
+    id: string;
+    state: OtkState;
+    otKeyParams: string;
+    otKeyCipher: string;
+    sharedKey: Key;
+    mkSharedKey: Key;
+    initiatorSigPxk: Key;
+    responderSigPxk: Key;
+    initiatorOneTimePbkCipher: string;
+    responderPbkCipher?: string;
+}
+export interface KeyExchange {
+    id: string;
+    state: KeyExchangeState;
+    mode: KeyExchangeMode;
+    created: string;
+    modified: string;
+    isInitiator: boolean;
+    initiator: {
+        id: string;
+        username: string;
+    };
+    responder: {
+        id: string;
+        username: string;
+    };
+    initiatorActionRequired?: boolean;
+    responderActionRequired?: boolean;
+    responderEmailAddress?: string;
+    token?: string;
+    tokenExpiryTime?: string;
+    isExpired?: boolean;
+    otk?: Otk;
+    initiatorRootKeyCipher: string;
+}
+export interface DecryptedKeyExchange extends KeyExchange {
+    decryptedOtk?: DecryptedOtk;
+    message?: KeyExchangeMessage;
+    contactCard?: TrustedPartyDetails;
+    myMessage?: KeyExchangeMessage;
+    myContactCard?: TrustedPartyDetails;
+}
+export interface GetKeyExchangeOptions {
+    otKeyK?: string;
+    token?: string;
+}
+export interface RespondOtk {
+    keyExchange: KeyExchange;
+    userSharedKey: UserSharedKey;
+    tp: {
+        id: string;
+    };
+}
+export interface CompleteOtk {
+    keyExchange: KeyExchange;
+    userSharedKey: UserSharedKey;
+    tp: {
+        id: string;
+    };
+}
+export interface UserSharedKey {
+    userSigPrk: Key;
+    sharedKey: Key;
+    mkSharedKey?: Key;
+    mkPxk?: Key;
+    mkReshareRequestCipher?: string;
+    mkReshareResponseCipher?: string;
+    mkReshareRequestSent?: boolean;
+    mkReshareResponseSent?: boolean;
+}
+export interface GetKeyExchangeListOptions {
+    orderBy?: 'created' | '-created' | 'modified' | '-modified' | 'expiry_time' | '-expiry_time';
+    isExpired?: boolean;
+    initiatorActionRequired?: boolean;
+    responderActionRequired?: boolean;
+    initiator?: string;
+    responder?: string;
+    state?: 'IN_PROGRESS' | 'COMPLETED' | 'DECLINED' | 'CANCELLED';
+}
+export interface PlainResponderPbkCipher {
+    otKey: object;
+}