Class RsaKeys

The parent key. Doesn't implement the encrypt/sign functions.

Hierarchy (View Summary)

AbstractKeys
- RsaKeys

Constructors

constructor

new RsaKeys(opts: KeyArgs): RsaKeys
Parameters
- opts: KeyArgs
Returns RsaKeys
Overrides AbstractKeys.constructor
- Defined in rsa/index.ts:79

Properties

DID

DID: `did:key:z${string}`

exchangeKey

exchangeKey: CryptoKeyPair

hasPersisted

hasPersisted: boolean

isSessionOnly

isSessionOnly: boolean

writeKey

writeKey: CryptoKeyPair

`Static`_instance

_instance: any

`Static`EXCHANGE_KEY_NAME

EXCHANGE_KEY_NAME: string = DEFAULT_RSA_EXCHANGE

`Static`INFO

INFO: string = 'keys'

`Static`TYPE

TYPE: "rsa" = ...

`Static`WRITE_KEY_NAME

WRITE_KEY_NAME: string = DEFAULT_RSA_WRITE

Accessors

deviceName

get deviceName(): Promise<string>
The machine-readable name for this keypair.

Returns Promise<string>
Inherited from AbstractKeys.deviceName
- Defined in _base.ts:202

privateExchangeKey

get privateExchangeKey(): CryptoKey
Returns CryptoKey
Inherited from AbstractKeys.privateExchangeKey
- Defined in _base.ts:195

privateWriteKey

get privateWriteKey(): CryptoKey
Returns CryptoKey
Inherited from AbstractKeys.privateWriteKey
- Defined in _base.ts:191

publicExchangeKey

get publicExchangeKey(): CryptoKey & {
asString: (format?: SupportedEncodings) => Promise<string>;
}
Returns CryptoKey & { asString: (format?: SupportedEncodings) => Promise<string> }
Inherited from AbstractKeys.publicExchangeKey
- Defined in _base.ts:180

publicWriteKey

get publicWriteKey(): CryptoKey & {
asString: (format?: SupportedEncodings) => Promise<string>;
}
Returns CryptoKey & { asString: (format?: SupportedEncodings) => Promise<string> }
Inherited from AbstractKeys.publicWriteKey
- Defined in _base.ts:169

Methods

decrypt

decrypt(
    msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>,
    keysize?: string | CryptoKey | SymmKeyLength,
    _aesAlgorithm?: string,
): Promise<Uint8Array<ArrayBufferLike>>
Decrypt the given message. Expects encrypted AES key + encrypted content.
Parameters
- msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>
- Optionalkeysize: string | CryptoKey | SymmKeyLength
- Optional_aesAlgorithm: string
Returns Promise<Uint8Array<ArrayBufferLike>>
Overrides AbstractKeys.decrypt
- Defined in rsa/index.ts:203

decryptAsString

decryptAsString(
    msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>,
    keysize?: string | CryptoKey | SymmKeyLength,
    _aesAlgorithm?: string,
): Promise<string>
Decrypt and return as string.
Parameters
- msg: string | ArrayBuffer | Uint8Array<ArrayBufferLike>
- Optionalkeysize: string | CryptoKey | SymmKeyLength
- Optional_aesAlgorithm: string
Returns Promise<string>
Overrides AbstractKeys.decryptAsString
- Defined in rsa/index.ts:223

decryptKey

decryptKey(
key: string | ArrayBuffer | Uint8Array<ArrayBufferLike>,
): Promise<Uint8Array<ArrayBufferLike>>
Decrypt the given encrypted AES key. Return the key as Uint8Array.
Parameters
- key: string | ArrayBuffer | Uint8Array<ArrayBufferLike>
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in rsa/index.ts:236

decryptKeyAsString

decryptKeyAsString(
msg: string | Uint8Array<ArrayBufferLike>,
format?: SupportedEncodings,
): Promise<string>
Decrypt the given AES key, return the result as a string.
Parameters
- msg: string | Uint8Array<ArrayBufferLike>
- Optionalformat: SupportedEncodings
Returns Promise<string>
- Defined in rsa/index.ts:247

delete

delete(): Promise<void>
Delete the keys stored in indexedDB.

Returns Promise<void>
Inherited from AbstractKeys.delete
- Defined in _base.ts:246

encrypt

encrypt(
    content: string | Uint8Array<ArrayBufferLike>,
    recipient?: string | CryptoKey,
    aesKeyOrInfo?: string | Uint8Array<ArrayBufferLike> | CryptoKey,
    keysizeOrAesKey?:
        | string
        | Uint8Array<ArrayBufferLike>
        | CryptoKey
        | SymmKeyLength,
    keysize?: SymmKeyLength,
): Promise<Uint8Array<ArrayBufferLike>>
Encrypt content using hybrid encryption (RSA + AES).
Parameters
- content: string | Uint8Array<ArrayBufferLike>
- Optionalrecipient: string | CryptoKey
- OptionalaesKeyOrInfo: string | Uint8Array<ArrayBufferLike> | CryptoKey
- OptionalkeysizeOrAesKey: string | Uint8Array<ArrayBufferLike> | CryptoKey | SymmKeyLength
- Optionalkeysize: SymmKeyLength
Returns Promise<Uint8Array<ArrayBufferLike>>
Overrides AbstractKeys.encrypt
- Defined in rsa/index.ts:163

encryptAsString

encryptAsString(
    content: string | Uint8Array<ArrayBufferLike>,
    recipient?: string | CryptoKey,
    aesKeyOrInfo?: string | Uint8Array<ArrayBufferLike> | CryptoKey,
    keysizeOrAesKey?:
        | string
        | Uint8Array<ArrayBufferLike>
        | CryptoKey
        | SymmKeyLength,
    keysize?: SymmKeyLength,
): Promise<string>
Encrypt and return as base64 string.
Parameters
- content: string | Uint8Array<ArrayBufferLike>
- Optionalrecipient: string | CryptoKey
- OptionalaesKeyOrInfo: string | Uint8Array<ArrayBufferLike> | CryptoKey
- OptionalkeysizeOrAesKey: string | Uint8Array<ArrayBufferLike> | CryptoKey | SymmKeyLength
- Optionalkeysize: SymmKeyLength
Returns Promise<string>
Overrides AbstractKeys.encryptAsString
- Defined in rsa/index.ts:189

getAesKey

getAesKey(
encryptedKey?: string | CryptoKey | null,
_info?: string | null,
): Promise<CryptoKey>
Get the relevant AES key for RSA - decrypt the given encrypted key.
Parameters
- OptionalencryptedKey: string | CryptoKey | null
- Optional_info: string | null
Returns Promise<CryptoKey>
Overrides AbstractKeys.getAesKey
- Defined in rsa/index.ts:262

getDeviceName

getDeviceName(): Promise<string>
Return a 32-character, DNS friendly hash of the public signing key.

Returns Promise<string>
Inherited from AbstractKeys.getDeviceName
- Defined in _base.ts:264

persist

persist(): Promise<void>
Save this keys instance to indexedDB.

Returns Promise<void>
Inherited from AbstractKeys.persist
- Defined in _base.ts:229

publicExchangeKeyAsString

publicExchangeKeyAsString(format?: SupportedEncodings): Promise<string>
Parameters
- Optionalformat: SupportedEncodings
Returns Promise<string>
Inherited from AbstractKeys.publicExchangeKeyAsString
- Defined in _base.ts:161

publicWriteKeyAsString

publicWriteKeyAsString(format?: SupportedEncodings): Promise<string>
Parameters
- Optionalformat: SupportedEncodings
Returns Promise<string>
Inherited from AbstractKeys.publicWriteKeyAsString
- Defined in _base.ts:165

sign

sign(msg: Msg, charsize?: CharSize): Promise<Uint8Array<ArrayBufferLike>>
Sign the message, and return the signature as a Uint8Array.
Parameters
- msg: Msg
- charsize: CharSize = DEFAULT_CHAR_SIZE
Returns Promise<Uint8Array<ArrayBufferLike>>
Overrides AbstractKeys.sign
- Defined in rsa/index.ts:138

signAsString

signAsString(msg: Msg, charsize?: CharSize): Promise<string>
Sign a message, return the signature as a base64 encoded string.
Parameters
- msg: Msg
- Optionalcharsize: CharSize
Returns Promise<string>
Overrides AbstractKeys.signAsString
- Defined in rsa/index.ts:155

toJson

toJson(
format?: SupportedEncodings,
): Promise<{ DID: `did:key:z${string}`; publicExchangeKey: string }>
Serialize this keys instance. Will return an object of { DID, publicExchangeKey }, where DID is the public signature key, and publicExchangeKey is the encryption key, base64 encoded.
Parameters
- Optionalformat: SupportedEncodings
Returns Promise<{ DID: `did:key:z${string}`; publicExchangeKey: string }>
Overrides AbstractKeys.toJson
- Defined in rsa/index.ts:113

`Static`_createExchangeKeys

_createExchangeKeys(extractable?: boolean): Promise<CryptoKeyPair>
Parameters
- extractable: boolean = false
Returns Promise<CryptoKeyPair>
Overrides AbstractKeys._createExchangeKeys
- Defined in rsa/index.ts:85

`Static`_createWriteKeys

_createWriteKeys(extractable?: boolean): Promise<CryptoKeyPair>
Parameters
- extractable: boolean = false
Returns Promise<CryptoKeyPair>
Overrides AbstractKeys._createWriteKeys
- Defined in rsa/index.ts:96

`Static`create

create<T extends AbstractKeys = RsaKeys>(
    session?: boolean,
    extractable?: boolean,
    keys?: {
        exchangeKeys?: CryptoKeyPair | null;
        writeKeys?: CryptoKeyPair | null;
    },
): Promise<T>
Factory function.
Type Parameters
- T extends AbstractKeys = RsaKeys
Parameters
- Optionalsession: boolean
  Session only? i.e., not saved in indexedDB. Default false.
- Optionalextractable: boolean
  Can we extract the private keys? Default false.
- Optionalkeys: { exchangeKeys?: CryptoKeyPair | null; writeKeys?: CryptoKeyPair | null }
  A set of keys to use here.
Returns Promise<T>
A new class instance.
Overrides AbstractKeys.create
- Defined in rsa/index.ts:68

`Static`deviceName

deviceName(did: `did:key:z${string}`): Promise<string>
Return a 32-character, DNS-friendly hash of the given DID.
Parameters
- did: `did:key:z${string}`
  A DID format string
Returns Promise<string>
32 character, base32 hash of the DID
Inherited from AbstractKeys.deviceName
- Defined in _base.ts:212

`Static`exist

exist(
opts?: { encryptionKeyName?: string; writeKeyName?: string },
): Promise<boolean>
Parameters
- opts: { encryptionKeyName?: string; writeKeyName?: string } = {}
Returns Promise<boolean>
Inherited from AbstractKeys.exist
- Defined in _base.ts:310

`Static`load

load<T extends AbstractKeys = AbstractKeys>(
    this: ChildKeys<AbstractKeys> & typeof AbstractKeys,
    opts?: Partial<
        {
            encryptionKeyName: string;
            extractable: boolean;
            session: boolean;
            writeKeyName: string;
        },
    >,
): Promise<T>
Restore some keys from indexedDB, or create a new keypair if it doesn't exist yet.
Type Parameters
- T extends AbstractKeys = AbstractKeys
Parameters
- this: ChildKeys<AbstractKeys> & typeof AbstractKeys
- opts: Partial<
      {
          encryptionKeyName: string;
          extractable: boolean;
          session: boolean;
          writeKeyName: string;
      },
  > = ...
  Strings to use as keys in indexedDB, and a session boolean, is this in memory only? Or can it be persisted.
Returns Promise<T>
Inherited from AbstractKeys.load
- Defined in _base.ts:329

Class RsaKeys

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RsaKeys

Properties

DID

exchangeKey

hasPersisted

isSessionOnly

writeKey

Static_instance

StaticEXCHANGE_KEY_NAME

StaticINFO

StaticTYPE

StaticWRITE_KEY_NAME

Accessors

deviceName

Returns Promise<string>

privateExchangeKey

Returns CryptoKey

privateWriteKey

Returns CryptoKey

publicExchangeKey

Returns CryptoKey & { asString: (format?: SupportedEncodings) => Promise<string> }

publicWriteKey

Returns CryptoKey & { asString: (format?: SupportedEncodings) => Promise<string> }

Methods

decrypt

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

decryptAsString

Parameters

Returns Promise<string>

decryptKey

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

decryptKeyAsString

Parameters

Returns Promise<string>

delete

Returns Promise<void>

encrypt

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

encryptAsString

Parameters

Returns Promise<string>

getAesKey

Parameters

Returns Promise<CryptoKey>

getDeviceName

Returns Promise<string>

persist

Returns Promise<void>

publicExchangeKeyAsString

Parameters

Returns Promise<string>

publicWriteKeyAsString

Parameters

Returns Promise<string>

sign

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

signAsString

Parameters

Returns Promise<string>

toJson

Parameters

Returns Promise<{ DID: `did:key:z${string}`; publicExchangeKey: string }>

Static_createExchangeKeys

Parameters

Returns Promise<CryptoKeyPair>

Static_createWriteKeys

`Static`_instance

`Static`EXCHANGE_KEY_NAME

`Static`INFO

`Static`TYPE

`Static`WRITE_KEY_NAME

`Static`_createExchangeKeys

`Static`_createWriteKeys

`Static`create

`Static`deviceName

`Static`exist

`Static`load