@sudoplatform/sudo-common 7.0.2 → 8.0.0

package/github/src/sudoKeyArchive/keyArchive.ts

@@ -1,120 +0,0 @@
-import * as t from 'io-ts'
-import { KeyArchiveKeyInfoCodec } from './keyInfo'
-
-export const CURRENT_ARCHIVE_VERSION = 3
-
-const CommonKeyArchiveRequiredProps = {
-  /**
-   * Version this arhive format.
-   */
-  Version: t.literal(CURRENT_ARCHIVE_VERSION),
-
-  /**
-   * Metainfo user is able to associate with the archive.
-   */
-  MetaInfo: t.record(t.string, t.string),
-}
-
-export const InsecureKeyArchiveType = 'Insecure'
-
-const InsecureKeyArchiveRequiredProps = {
-  ...CommonKeyArchiveRequiredProps,
-  /**
-   * Disciminant for InsecureKeyArchive type.
-   */
-  Type: t.literal(InsecureKeyArchiveType),
-
-  /**
-   * Array of exported keys in clear text.
-   */
-  Keys: t.array(KeyArchiveKeyInfoCodec),
-}
-
-export const InsecureKeyArchiveCodec = t.type(
-  InsecureKeyArchiveRequiredProps,
-  'InsecureKeyArchive',
-)
-export type InsecureKeyArchive = t.TypeOf<typeof InsecureKeyArchiveCodec>
-
-export const SecureKeyArchiveType = 'Secure'
-
-const SecureKeyArchiveRequiredProps = {
-  ...CommonKeyArchiveRequiredProps,
-  /**
-   * Disciminant for SecureKeyArchive type.
-   */
-  Type: t.literal(SecureKeyArchiveType),
-
-  /**
-   * Format is:
-   *
-   * base64(gzip(encrypt(stringify(array of KeyArchiveKeyInfo)))
-   *
-   * Encrypt is 256-bit AES-CBC using symmetric key derived from
-   * password and IV specified by IV property.
-   */
-  Keys: t.string,
-
-  /**
-   * Rounds of PBKDF2 applied to password to derive symmetric key.
-   */
-  Rounds: t.number,
-
-  /**
-   * Salt passed to PBKDF2 to derive symmetric key.
-   */
-  Salt: t.string,
-
-  /**
-   * IV used for AES encryption of keys.
-   */
-  IV: t.string,
-}
-
-const UnrecognizedKeyArchiveProps = {
-  Version: t.number,
-  Type: t.string,
-}
-
-export const UnrecognizedKeyArchiveCodec = t.partial(
-  UnrecognizedKeyArchiveProps,
-)
-export type UnrecognizedKeyArchive = t.TypeOf<
-  typeof UnrecognizedKeyArchiveCodec
->
-
-export const SecureKeyArchiveCodec = t.type(
-  SecureKeyArchiveRequiredProps,
-  'SecureKeyArchive',
-)
-export type SecureKeyArchive = t.TypeOf<typeof SecureKeyArchiveCodec>
-
-export const KeyArchiveCodec = t.union(
-  [
-    SecureKeyArchiveCodec,
-    InsecureKeyArchiveCodec,
-
-    // Leave UnrecognizedKeyArchiveCodec last so it's tried last
-    UnrecognizedKeyArchiveCodec,
-  ],
-  'KeyArchive',
-)
-export type KeyArchive = t.TypeOf<typeof KeyArchiveCodec>
-
-export function isSecureKeyArchive(
-  keyArchive: KeyArchive,
-): keyArchive is SecureKeyArchive {
-  return keyArchive.Type === SecureKeyArchiveType
-}
-
-export function isInsecureKeyArchive(
-  keyArchive: KeyArchive,
-): keyArchive is InsecureKeyArchive {
-  return keyArchive.Type === InsecureKeyArchiveType
-}
-
-export function isUnrecognizedKeyArchive(
-  keyArchive: KeyArchive,
-): keyArchive is UnrecognizedKeyArchive {
-  return !isSecureKeyArchive(keyArchive) && !isInsecureKeyArchive(keyArchive)
-}

package/github/src/sudoKeyArchive/keyInfo.ts

@@ -1,47 +0,0 @@
-import * as t from 'io-ts'
-
-import { KeyArchiveKeyTypeCodec } from './keyType'
-
-const KeyArchiveKeyInfoRequiredProps = {
-  Name: t.string,
-  Type: KeyArchiveKeyTypeCodec,
-  Data: t.string,
-  Synchronizable: t.boolean,
-  Exportable: t.boolean,
-  NameSpace: t.string,
-}
-
-export const KeyArchiveKeyInfoCodec = t.type(
-  KeyArchiveKeyInfoRequiredProps,
-  'KeyArchiveKeyInfo',
-)
-
-export const KeyArchiveKeyInfoArrayCodec = t.array(
-  KeyArchiveKeyInfoCodec,
-  'KeyArchiveKeyInfoArray',
-)
-
-/**
- * Record of key in a key archive
- *
- * @property NameSpace
- *     NameSpace to which the key belongs.
- *
- * @property Name
- *     Name of the key within the namespace
- *
- * @property Type
- *     Type of the key (also implies key format)
- *
- * @property Data
- *     Base64 encoded key data
- *
- * @property Synchronizable
- *     Whether key should be synced out of band of archiving.
- *     For future use - always false for now.
- *
- * @property Exportable
- *     Whether restored key should be exportable. Always true on archive.
- *     For future use on unarchive.
- */
-export type KeyArchiveKeyInfo = t.TypeOf<typeof KeyArchiveKeyInfoCodec>

package/github/src/sudoKeyArchive/keyType.ts

@@ -1,50 +0,0 @@
-import * as t from 'io-ts'
-
-/**
- * Key types supported in key archives
- *
- * These form part of the interoperable secure key archive format.
- */
-export enum KeyArchiveKeyType {
-  // Byte array of secret data - to be stored and retrievable using *Password
-  // methods on key managers
-  Password = 'password',
-
-  // PKCS8 PrivateKey encoded RSA private key
-  PrivateKey = 'privateKey',
-
-  // SPKI encoded RSA public key
-  PublicKey = 'publicKey',
-
-  // Byte array of AES symmetric key
-  SymmetricKey = 'symmetricKey',
-}
-
-// Android is tolerating the following case insensitive alias key type
-// names so we will do the same
-const keyArchiveKeyTypeAlternatives: Record<string, KeyArchiveKeyType> = {
-  password: KeyArchiveKeyType.Password,
-  privatekey: KeyArchiveKeyType.PrivateKey,
-  private_key: KeyArchiveKeyType.PrivateKey,
-  publickey: KeyArchiveKeyType.PublicKey,
-  public_key: KeyArchiveKeyType.PublicKey,
-  symmetrickey: KeyArchiveKeyType.SymmetricKey,
-  symmetric_key: KeyArchiveKeyType.SymmetricKey,
-}
-
-const failureMessage = `Key type is not one of: ${Object.keys(
-  keyArchiveKeyTypeAlternatives,
-).join(',')}`
-
-const isKeyArchiveKeyType = (u: unknown): u is KeyArchiveKeyType =>
-  t.string.is(u) && keyArchiveKeyTypeAlternatives[u.toLowerCase()] !== undefined
-
-export const KeyArchiveKeyTypeCodec = new t.Type<KeyArchiveKeyType, string>(
-  'KeyArchiveKeyType',
-  isKeyArchiveKeyType,
-  (u, c) =>
-    isKeyArchiveKeyType(u)
-      ? t.success(keyArchiveKeyTypeAlternatives[u.toLowerCase()])
-      : t.failure(u, c, failureMessage),
-  t.identity,
-)