Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

2.2 KB
Raw Blame
//-----------------------------------------------------------------------
// <copyright file="VaultKeyResponse.cs" company="aliasvault">
// Copyright (c) aliasvault. All rights reserved.
// Licensed under the AGPLv3 license. See LICENSE.md file in the project root for full license information.
// </copyright>
//-----------------------------------------------------------------------

namespace AliasVault.Shared.Models.WebApi.V2.Auth;

/// <summary>
/// Response for GET /v2/VaultKey/{type}: the encrypted Account Key and KEK derivation parameters for the given unlock method.
/// </summary>
public class VaultKeyResponse
{
    /// <summary>Gets or sets the unlock method type.</summary>
    public required string Type { get; set; }

    /// <summary>Gets or sets the Account Key encrypted with the KEK derived from the unlock method.</summary>
    public required string EncryptedAccountKey { get; set; }

    /// <summary>Gets or sets the algorithm of <see cref="EncryptedAccountKey"/>, as a VaultKeyAlgorithm token.</summary>
    public required string Algorithm { get; set; }

    /// <summary>Gets or sets the account private key encrypted with the Account Key.</summary>
    public string? EncryptedAccountPrivateKey { get; set; }

    /// <summary>Gets or sets the account public key.</summary>
    public string? AccountPublicKey { get; set; }

    /// <summary>Gets or sets the account signing public key.</summary>
    public string? SigningPublicKey { get; set; }

    /// <summary>Gets or sets the account signing private key encrypted with the Account Key.</summary>
    public string? EncryptedSigningPrivateKey { get; set; }

    /// <summary>
    /// Gets or sets the encrypted VEK.
    /// </summary>
    public string? EncryptedVek { get; set; }

    /// <summary>Gets or sets the salt used for KEK derivation.</summary>
    public required string Salt { get; set; }

    /// <summary>Gets or sets the key derivation type.</summary>
    public required string EncryptionType { get; set; }

    /// <summary>Gets or sets the key derivation settings.</summary>
    public required string EncryptionSettings { get; set; }

    /// <summary>Gets or sets the generation of the personal VEK that <see cref="EncryptedVek"/> yields.</summary>
    public int KeyVersion { get; set; }
}