src/security/v1/sec-tpm-osx.hpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
 * Copyright (c) 2013-2017 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 *
 * @author Yingdi Yu <http://irl.cs.ucla.edu/~yingdi/>
 */

#ifndef NDN_SECURITY_V1_SEC_TPM_OSX_HPP
#define NDN_SECURITY_V1_SEC_TPM_OSX_HPP

#include "../../common.hpp"

#ifndef NDN_CXX_HAVE_OSX_SECURITY
#error "This files should not be compiled ..."
#endif

#include "sec-tpm.hpp"

namespace ndn {
namespace security {
namespace v1 {

class SecTpmOsx : public SecTpm
{
public:
  class Error : public SecTpm::Error
  {
  public:
    explicit
    Error(const std::string& what)
      : SecTpm::Error(what)
    {
    }
  };

  explicit
  SecTpmOsx(const std::string& location = "");

  virtual
  ~SecTpmOsx();

  // Following methods are inherited from SecTpm
  virtual void
  setTpmPassword(const uint8_t* password, size_t passwordLength);

  virtual void
  resetTpmPassword();

  virtual void
  setInTerminal(bool inTerminal);

  virtual bool
  getInTerminal() const;

  virtual bool
  isLocked();

  virtual bool
  unlockTpm(const char* password, size_t passwordLength, bool usePassword);

  virtual void
  generateKeyPairInTpm(const Name& keyName, const KeyParams& params)
  {
    generateKeyPairInTpmInternal(keyName, params, false);
  }

  virtual void
  deleteKeyPairInTpm(const Name& keyName)
  {
    deleteKeyPairInTpmInternal(keyName, false);
  }

  virtual shared_ptr<v1::PublicKey>
  getPublicKeyFromTpm(const Name& keyName);

  virtual Block
  signInTpm(const uint8_t* data, size_t dataLength,
            const Name& keyName, DigestAlgorithm digestAlgorithm)
  {
    return signInTpmInternal(data, dataLength, keyName, digestAlgorithm, false);
  }

  virtual ConstBufferPtr
  decryptInTpm(const uint8_t* data, size_t dataLength, const Name& keyName, bool isSymmetric);

  virtual ConstBufferPtr
  encryptInTpm(const uint8_t* data, size_t dataLength, const Name& keyName, bool isSymmetric);

  virtual void
  generateSymmetricKeyInTpm(const Name& keyName, const KeyParams& params);

  virtual bool
  doesKeyExistInTpm(const Name& keyName, KeyClass keyClass);

  virtual bool
  generateRandomBlock(uint8_t* res, size_t size);

  virtual void
  addAppToAcl(const Name& keyName, KeyClass keyClass, const std::string& appPath, AclType acl);

protected:
  // Following methods are inherited from SecTpm
  virtual std::string
  getScheme();

  virtual ConstBufferPtr
  exportPrivateKeyPkcs8FromTpm(const Name& keyName)
  {
    return exportPrivateKeyPkcs8FromTpmInternal(keyName, false);
  }

  virtual bool
  importPrivateKeyPkcs8IntoTpm(const Name& keyName, const uint8_t* buf, size_t size)
  {
    return importPrivateKeyPkcs8IntoTpmInternal(keyName, buf, size, false);
  }

  virtual bool
  importPublicKeyPkcs1IntoTpm(const Name& keyName, const uint8_t* buf, size_t size);

  // Following methods are OSX-specific
  void
  generateKeyPairInTpmInternal(const Name& keyName, const KeyParams& params, bool needRetry);

  void
  deleteKeyPairInTpmInternal(const Name& keyName, bool needRetry);

  ConstBufferPtr
  exportPrivateKeyPkcs8FromTpmInternal(const Name& keyName, bool needRetry);

  bool
  importPrivateKeyPkcs8IntoTpmInternal(const Name& keyName,
                                       const uint8_t* buf, size_t size,
                                       bool needRetry);

  Block
  signInTpmInternal(const uint8_t* data, size_t dataLength,
                    const Name& keyName, DigestAlgorithm digestAlgorithm,
                    bool needRetry);

public:
  static const std::string SCHEME;

private:
  class Impl;
  shared_ptr<Impl> m_impl;
};

} // namespace v1
} // namespace security
} // namespace ndn

#endif // NDN_SECURITY_V1_SEC_TPM_OSX_HPP