// Copyright 2020 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CRYPTOHOME_FILE_SYSTEM_KEYS_H_
#define CRYPTOHOME_FILE_SYSTEM_KEYS_H_

#include <brillo/secure_blob.h>

#include <string>

#include "cryptohome/vault_keyset.h"

namespace cryptohome {

// This class wraps the file encryption keys and serves as a common interface
// across mount and authentication operations for these keys.
class FileSystemKeys final {
 public:
  FileSystemKeys();
  FileSystemKeys(const std::string& username,
                 const cryptohome::VaultKeyset& vault_keyset);
  ~FileSystemKeys();

  // Getters for the associated key data
  const brillo::SecureBlob& fek() const;
  const brillo::SecureBlob& fek_salt() const;
  const brillo::SecureBlob& fek_sig() const;
  const brillo::SecureBlob& fnek() const;
  const brillo::SecureBlob& fnek_salt() const;
  const brillo::SecureBlob& fnek_sig() const;
  const brillo::SecureBlob& chaps_key() const;

  // Return plaintext username.
  const std::string& username() const;

 private:
  // Plain text username for identification of user.
  std::string username_;

  // Keys for file encryption. Currently we would need file_encryption_key(fek)
  // file_name_encryption_key (fnek), fek_salt, fnek_salt, fek_sig, fnek_sig.
  // The fnek keys are used only in the older Ecryptfs operations.
  brillo::SecureBlob fek_;
  brillo::SecureBlob fek_salt_;
  brillo::SecureBlob fek_sig_;
  brillo::SecureBlob fnek_;
  brillo::SecureBlob fnek_sig_;
  brillo::SecureBlob fnek_salt_;
  // Chaps keys are stored in keysets right now and are used as part of mount
  // operations.
  brillo::SecureBlob chaps_key_;
};

}  // namespace cryptohome

#endif  // CRYPTOHOME_FILE_SYSTEM_KEYS_H_