libhwsec-foundation/crypto/libscrypt_compat.h

// 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 LIBHWSEC_FOUNDATION_CRYPTO_LIBSCRYPT_COMPAT_H_
#define LIBHWSEC_FOUNDATION_CRYPTO_LIBSCRYPT_COMPAT_H_

#include <brillo/secure_blob.h>

#include <stdint.h>

#include "libhwsec-foundation/crypto/scrypt.h"
#include "libhwsec-foundation/hwsec-foundation_export.h"

namespace hwsec_foundation {

// Callers of this library need to allocate the salt and key, so the sizes are
// exposed.
inline constexpr size_t kLibScryptSaltSize = 32;
inline constexpr size_t kLibScryptDerivedKeySize = 64;

// This class maintains compatibility with buffers that were previously
// encrypted with the libscrypt specific header. It allows the actual scrypt key
// derivation to be split from the header, encryption, and HMAC.
class HWSEC_FOUNDATION_EXPORT LibScryptCompat {
 public:
  // This encrypts the |data_to_encrypt| with the |derived_key|. Although the
  // core of this is standard AES-256-CTR, this is libscrypt specific in that it
  // puts the header in the blob, and then HMACs the encrypted data. This
  // specific format must be preserved for backwards compatibility. USS code
  // will generate an AES-256 key, and the rest of the key hierarchy is
  // universal.
  static bool Encrypt(const brillo::SecureBlob& derived_key,
                      const brillo::SecureBlob& salt,
                      const brillo::SecureBlob& data_to_encrypt,
                      const ScryptParameters& params,
                      brillo::SecureBlob* encrypted_data);

  // This parses the header from |encrypted_blob| which is a blob previously
  // output by libscrypt's `scryptenc_buf` or this compatibility library's
  // `GenerateEncryptedOutput`. This returns the salt as well.
  static bool ParseHeader(const brillo::SecureBlob& encrypted_blob,
                          ScryptParameters* out_params,
                          brillo::SecureBlob* salt);

  // This decrypts a blob that was encrypted by libscrypt. It's basically
  // AES-256-CTR with libscrypt's custom HMAC check.
  static bool Decrypt(const brillo::SecureBlob& encrypted_blob,
                      const brillo::SecureBlob& derived_key,
                      brillo::SecureBlob* decrypted_data);
};

}  // namespace hwsec_foundation

#endif  // LIBHWSEC_FOUNDATION_CRYPTO_LIBSCRYPT_COMPAT_H_