consistent
This commit is contained in:
@@ -222,7 +222,7 @@ export const authenticatorEntityDiff = async (
|
||||
|
||||
export const AuthenticatorEntityKey = z.object({
|
||||
/**
|
||||
* The authenticator entity key (base 64 string), encrypted with the user's
|
||||
* The authenticator entity key (base64 string), encrypted with the user's
|
||||
* master key.
|
||||
*/
|
||||
encryptedKey: z.string(),
|
||||
|
||||
@@ -34,7 +34,7 @@ export interface KeyAttributes {
|
||||
/**
|
||||
* The user's master key encrypted with the key encryption key.
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*
|
||||
* [Note: Key encryption key]
|
||||
*
|
||||
@@ -56,7 +56,7 @@ export interface KeyAttributes {
|
||||
/**
|
||||
* The nonce used during the encryption of the master key.
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*
|
||||
* @see {@link encryptedKey}.
|
||||
*/
|
||||
@@ -64,7 +64,7 @@ export interface KeyAttributes {
|
||||
/**
|
||||
* The salt used during the derivation of the kek.
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*
|
||||
* See: [Note: Key encryption key].
|
||||
*/
|
||||
@@ -90,14 +90,14 @@ export interface KeyAttributes {
|
||||
* The user's public key (part of their public-key keypair, the other half
|
||||
* being the {@link encryptedSecretKey}).
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*/
|
||||
publicKey: string;
|
||||
/**
|
||||
* The user's private key (part of their public-key keypair, the other half
|
||||
* being the {@link publicKey}) encrypted with their master key.
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*
|
||||
* [Note: Public and secret key nomenclature]
|
||||
*
|
||||
@@ -114,7 +114,7 @@ export interface KeyAttributes {
|
||||
/**
|
||||
* The user's master key after being encrypted with their recovery key.
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*
|
||||
* This allows the user to recover their master key if they forget their
|
||||
* passphrase but still have their recovery key.
|
||||
@@ -126,13 +126,13 @@ export interface KeyAttributes {
|
||||
* The nonce used during the encryption of
|
||||
* {@link masterKeyEncryptedWithRecoveryKey}.
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*/
|
||||
masterKeyDecryptionNonce?: string;
|
||||
/**
|
||||
* The user's recovery key after being encrypted with their master key.
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*
|
||||
* Note: This value doesn't change after being initially created.
|
||||
*/
|
||||
@@ -141,7 +141,7 @@ export interface KeyAttributes {
|
||||
* The nonce used during the encryption of
|
||||
* {@link recoveryKeyEncryptedWithMasterKey}.
|
||||
*
|
||||
* Base 64 encoded.
|
||||
* Base64 encoded.
|
||||
*/
|
||||
recoveryKeyDecryptionNonce?: string;
|
||||
}
|
||||
|
||||
@@ -111,7 +111,7 @@ export const toHex = async (input: string) => {
|
||||
};
|
||||
|
||||
/**
|
||||
* Convert a hex string to the base 64 representation of the bytes that the hex
|
||||
* Convert a hex string to the base64 representation of the bytes that the hex
|
||||
* string encodes.
|
||||
*
|
||||
* This is the inverse of {@link toHex}.
|
||||
|
||||
@@ -33,7 +33,7 @@ export const appendCollectionKeyToShareURL = async (
|
||||
* Extract the collection key from a public URL.
|
||||
*
|
||||
* This is the inverse of {@link appendCollectionKeyToShareURL}, returning the
|
||||
* base 64 string representation of the collection key.
|
||||
* base64 string representation of the collection key.
|
||||
*
|
||||
* collection key (bytes)
|
||||
* => appendCollectionKeytoShareURL (base 64 => base 58)
|
||||
|
||||
Reference in New Issue
Block a user