crypto/symmetric_key.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CRYPTO_SYMMETRIC_KEY_H_
   6 #define CRYPTO_SYMMETRIC_KEY_H_
   7
   8 #include <stddef.h>
   9
  10 #include <memory>
  11 #include <string>
  12
  13 #include "base/macros.h"
  14 #include "build/build_config.h"
  15 #include "crypto/crypto_export.h"
  16
  17 namespace crypto {
  18
  19 // Wraps a platform-specific symmetric key and allows it to be held in a
  20 // scoped_ptr.
  21 class CRYPTO_EXPORT SymmetricKey {
  22  public:
  23   // Defines the algorithm that a key will be used with. See also
  24   // classs Encrptor.
  25   enum Algorithm {
  26     AES,
  27     HMAC_SHA1,
  28   };
  29
  30   virtual ~SymmetricKey();
  31
  32   // Generates a random key suitable to be used with |algorithm| and of
  33   // |key_size_in_bits| bits. |key_size_in_bits| must be a multiple of 8.
  34   // The caller is responsible for deleting the returned SymmetricKey.
  35   static std::unique_ptr<SymmetricKey> GenerateRandomKey(
  36       Algorithm algorithm,
  37       size_t key_size_in_bits);
  38
  39   // Derives a key from the supplied password and salt using PBKDF2, suitable
  40   // for use with specified |algorithm|. Note |algorithm| is not the algorithm
  41   // used to derive the key from the password. |key_size_in_bits| must be a
  42   // multiple of 8. The caller is responsible for deleting the returned
  43   // SymmetricKey.
  44   static std::unique_ptr<SymmetricKey> DeriveKeyFromPasswordUsingPbkdf2(
  45       Algorithm algorithm,
  46       const std::string& password,
  47       const std::string& salt,
  48       size_t iterations,
  49       size_t key_size_in_bits);
  50
  51   // Derives a key from the supplied password and salt using scrypt, suitable
  52   // for use with specified |algorithm|. Note |algorithm| is not the algorithm
  53   // used to derive the key from the password. |cost_parameter|, |block_size|,
  54   // and |parallelization_parameter| correspond to the parameters |N|, |r|, and
  55   // |p| from the scrypt specification (see RFC 7914). |key_size_in_bits| must
  56   // be a multiple of 8. The caller is responsible for deleting the returned
  57   // SymmetricKey.
  58   static std::unique_ptr<SymmetricKey> DeriveKeyFromPasswordUsingScrypt(
  59       Algorithm algorithm,
  60       const std::string& password,
  61       const std::string& salt,
  62       size_t cost_parameter,
  63       size_t block_size,
  64       size_t parallelization_parameter,
  65       size_t max_memory_bytes,
  66       size_t key_size_in_bits);
  67
  68   // Imports an array of key bytes in |raw_key|. This key may have been
  69   // generated by GenerateRandomKey or DeriveKeyFromPassword{Pbkdf2,Scrypt} and
  70   // exported with key(). The key must be of suitable size for use with
  71   // |algorithm|. The caller owns the returned SymmetricKey.
  72   static std::unique_ptr<SymmetricKey> Import(Algorithm algorithm,
  73                                               const std::string& raw_key);
  74
  75   // Returns the raw platform specific key data.
  76   const std::string& key() const { return key_; }
  77
  78  private:
  79   SymmetricKey();
  80
  81   std::string key_;
  82
  83   DISALLOW_COPY_AND_ASSIGN(SymmetricKey);
  84 };
  85
  86 }  // namespace crypto
  87
  88 #endif  // CRYPTO_SYMMETRIC_KEY_H_