Class KeyManager

constructor

• new KeyManager(logger?: SoloLogger): KeyManager

• Parameters

  • Optionallogger: SoloLogger

  Returns KeyManager

StaticECKeyAlgo

StaticSigningKeyAlgo

StaticSigningKeyUsage

StaticTLSCertKeyExtendedUsages

StaticTLSCertKeyUsages

StaticTLSKeyAlgo

StaticTLSKeyUsage

convertPemToPrivateKey

• convertPemToPrivateKey(
      pemStr: string,
      algo: any,
      keyUsages?: KeyUsage[],
  ): Promise<CryptoKey>

• Convert PEM private key into CryptoKey

  Parameters

  • pemStr: string

    PEM string
  • algo: any

    key algorithm
  • OptionalkeyUsages: KeyUsage[] = ...

  Returns Promise<CryptoKey>

convertPrivateKeyToPem

• convertPrivateKeyToPem(privateKey: CryptoKey): Promise<string>

• Convert CryptoKey into PEM string

  Parameters

  • privateKey: CryptoKey

  Returns Promise<string>

copyGossipKeysToStaging

• copyGossipKeysToStaging(
      keysDir: string,
      stagingKeysDir: string,
      nodeAliases: NodeAliases,
  ): void

• Parameters

  • keysDir: string
  • stagingKeysDir: string
  • nodeAliases: NodeAliases

  Returns void

copyNodeKeysToStaging

• copyNodeKeysToStaging(
      nodeKey: PrivateKeyAndCertificateObject,
      destDir: string,
  ): void

• Parameters

  • nodeKey: PrivateKeyAndCertificateObject
  • destDir: string

  Returns void

generateGrpcTlsKey

• generateGrpcTlsKey(
      nodeAlias: `node${number}`,
      distinguishedName?: Name,
  ): Promise<NodeKeyObject>

• Generate gRPC TLS key

  It generates TLS keys in PEM format such as below: hedera-.key hedera-.crt

  Parameters

  • nodeAlias: `node${number}`
  • distinguishedName: Name = ...

    distinguished name as: new x509.Name(CN=${nodeAlias},ST=${state},L=${locality},O=${org},OU=${orgUnit},C=${country})

  Returns Promise<NodeKeyObject>

generateSigningKey

• generateSigningKey(nodeAlias: `node${number}`): Promise<NodeKeyObject>

• Generate signing key and certificate

  Parameters

  • nodeAlias: `node${number}`

  Returns Promise<NodeKeyObject>

getDerFromPemCertificate

• getDerFromPemCertificate(pemCertFullPath: string): Uint8Array<ArrayBuffer>

• Given the path to the PEM certificate (Base64 ASCII), will return the DER (raw binary) bytes

  Parameters

  • pemCertFullPath: string

  Returns Uint8Array<ArrayBuffer>

loadNodeKey

• loadNodeKey(
      nodeAlias: `node${number}`,
      keysDir: string,
      algo: any,
      nodeKeyFiles: PrivateKeyAndCertificateObject,
      keyName?: string,
  ): Promise<NodeKeyObject>

• Load node keys and certs from PEM files

  Parameters

  • nodeAlias: `node${number}`
  • keysDir: string

    directory where keys and certs are stored
  • algo: any

    algorithm used for key
  • nodeKeyFiles: PrivateKeyAndCertificateObject

    an object stores privateKeyFile and certificateFile
  • OptionalkeyName: string = ''

    optional key type name for logging

  Returns Promise<NodeKeyObject>

loadSigningKey

• loadSigningKey(
      nodeAlias: `node${number}`,
      keysDir: string,
  ): Promise<NodeKeyObject>

• Load signing key and certificate

  Parameters

  • nodeAlias: `node${number}`
  • keysDir: string

    directory path where pem files are stored

  Returns Promise<NodeKeyObject>

loadTLSKey

• loadTLSKey(nodeAlias: `node${number}`, keysDir: string): Promise<NodeKeyObject>

• Load TLS key and certificate

  Parameters

  • nodeAlias: `node${number}`
  • keysDir: string

    directory path where pem files are stored

  Returns Promise<NodeKeyObject>

prepareNodeKeyFilePaths

• prepareNodeKeyFilePaths(
      nodeAlias: `node${number}`,
      keysDir: string,
  ): PrivateKeyAndCertificateObject

• Return file names for node key

  Parameters

  • nodeAlias: `node${number}`
  • keysDir: string

    directory where keys and certs are stored

  Returns PrivateKeyAndCertificateObject

prepareTLSKeyFilePaths

• prepareTLSKeyFilePaths(
      nodeAlias: `node${number}`,
      keysDir: string,
  ): PrivateKeyAndCertificateObject

• Return file names for TLS key

  Parameters

  • nodeAlias: `node${number}`
  • keysDir: string

    directory where keys and certs are stored

  Returns PrivateKeyAndCertificateObject

storeNodeKey

• storeNodeKey(
      nodeAlias: `node${number}`,
      nodeKey: NodeKeyObject,
      keysDir: string,
      nodeKeyFiles: PrivateKeyAndCertificateObject,
      keyName?: string,
  ): Promise<PrivateKeyAndCertificateObject>

• Store node keys and certs as PEM files

  Parameters

  • nodeAlias: `node${number}`
  • nodeKey: NodeKeyObject
  • keysDir: string

    directory where keys and certs are stored
  • nodeKeyFiles: PrivateKeyAndCertificateObject
  • OptionalkeyName: string = ''

    optional key type name for logging

  Returns Promise<PrivateKeyAndCertificateObject>

  a Promise that saves the keys and certs as PEM files

storeSigningKey

• storeSigningKey(
      nodeAlias: `node${number}`,
      nodeKey: NodeKeyObject,
      keysDir: string,
  ): Promise<PrivateKeyAndCertificateObject>

• Store signing key and certificate

  Parameters

  • nodeAlias: `node${number}`
  • nodeKey: NodeKeyObject

    an object containing privateKeyPem, certificatePem data
  • keysDir: string

    directory where keys and certs are stored

  Returns Promise<PrivateKeyAndCertificateObject>

  returns a Promise that saves the keys and certs as PEM files

storeTLSKey

• storeTLSKey(
      nodeAlias: `node${number}`,
      nodeKey: NodeKeyObject,
      keysDir: string,
  ): Promise<PrivateKeyAndCertificateObject>

• Store TLS key and certificate

  Parameters

  • nodeAlias: `node${number}`
  • nodeKey: NodeKeyObject
  • keysDir: string

    directory where keys and certs are stored

  Returns Promise<PrivateKeyAndCertificateObject>

  a Promise that saves the keys and certs as PEM files

taskGenerateGossipKeys

• taskGenerateGossipKeys(
      nodeAliases: NodeAliases,
      keysDir: string,
      curDate?: Date,
      allNodeAliases?: NodeAliases,
  ): ListrTask[]

• Return a list of subtasks to generate gossip keys

  WARNING: These tasks MUST run in sequence.

  Parameters

  • nodeAliases: NodeAliases
  • keysDir: string

    keys directory
  • curDate: Date = ...

    current date
  • OptionalallNodeAliases: NodeAliases = null

    includes the nodeAliases to get new keys as well as existing nodeAliases that will be included in the public.pfx file

  Returns ListrTask[]

  a list of subtasks

taskGenerateTLSKeys

• taskGenerateTLSKeys(
      nodeAliases: NodeAliases,
      keysDir: string,
      curDate?: Date,
  ): ListrTask[]

• Return a list of subtasks to generate gRPC TLS keys

  WARNING: These tasks should run in sequence

  Parameters

  • nodeAliases: NodeAliases
  • keysDir: string

    keys directory
  • curDate: Date = ...

    current date

  Returns ListrTask[]

  return a list of subtasks