blob: 6ac28eae9637980c887ddb0247a9729f997795bb [file] [log] [blame]
Jeff Thompson2747dc02013-10-04 19:11:34 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
2/**
3 * Copyright (C) 2013 Regents of the University of California.
4 * @author: Yingdi Yu <yingdi@cs.ucla.edu>
5 * See COPYING for copyright and distribution information.
6 */
7
8#ifndef NDN_OSX_PRIVATEKEY_STORAGE_H
9#define NDN_OSX_PRIVATEKEY_STORAGE_H
10
Jeff Thompsonf21e2242013-10-09 19:01:49 -070011// Only compile if ndn-cpp-config.h defines NDN_CPP_HAVE_OSX_SECURITY 1.
Jeff Thompson6e229042013-10-10 11:09:49 -070012#include <ndn-cpp/ndn-cpp-config.h>
Jeff Thompsonf21e2242013-10-09 19:01:49 -070013#if NDN_CPP_HAVE_OSX_SECURITY
Jeff Thompson2747dc02013-10-04 19:11:34 -070014
15#include "../../common.hpp"
16#include "private-key-storage.hpp"
17
Jeff Thompson2747dc02013-10-04 19:11:34 -070018namespace ndn
19{
20
21class OSXPrivateKeyStorage : public PrivateKeyStorage {
22public:
23 /**
24 * constructor of OSXPrivateKeyStorage
25 * @param keychainName the name of keychain
26 */
27 OSXPrivateKeyStorage(const std::string & keychainName = "");
28
29 /**
30 * destructor of OSXPrivateKeyStore
31 */
32 virtual
33 ~OSXPrivateKeyStorage();
34
Alexander Afanasyev04b22a92014-01-05 22:40:17 -080035
36 // From PrivateKeyStorage
Jeff Thompson2747dc02013-10-04 19:11:34 -070037 virtual void
38 generateKeyPair(const Name& keyName, KeyType keyType = KEY_TYPE_RSA, int keySize = 2048);
39
Jeff Thompson2747dc02013-10-04 19:11:34 -070040 virtual ptr_lib::shared_ptr<PublicKey>
41 getPublicKey(const Name& keyName);
42
Alexander Afanasyev04b22a92014-01-05 22:40:17 -080043 virtual Block
44 sign(const uint8_t *data, size_t dataLength,
45 const Name& keyName, DigestAlgorithm digestAlgorithm = DIGEST_ALGORITHM_SHA256);
46
47 virtual void
48 sign(Data &data,
49 const Name& keyName, DigestAlgorithm digestAlgorithm = DIGEST_ALGORITHM_SHA256);
50
Jeff Thompson2747dc02013-10-04 19:11:34 -070051 /**
52 * Decrypt data.
53 * @param keyName The name of the decrypting key.
54 * @param data The byte to be decrypted.
55 * @param dataLength the length of data.
56 * @param isSymmetric If true symmetric encryption is used, otherwise asymmetric decryption is used.
57 * @return The decrypted data.
58 */
Alexander Afanasyev04b22a92014-01-05 22:40:17 -080059 virtual ConstBufferPtr
Jeff Thompson2747dc02013-10-04 19:11:34 -070060 decrypt(const Name& keyName, const uint8_t* data, size_t dataLength, bool isSymmetric = false);
61
62 /**
63 * Encrypt data.
64 * @param keyName The name of the encrypting key.
65 * @param data The byte to be encrypted.
66 * @param dataLength the length of data.
67 * @param isSymmetric If true symmetric encryption is used, otherwise asymmetric decryption is used.
68 * @return The encrypted data.
69 */
Alexander Afanasyev04b22a92014-01-05 22:40:17 -080070 virtual ConstBufferPtr
Jeff Thompson2747dc02013-10-04 19:11:34 -070071 encrypt(const Name& keyName, const uint8_t* data, size_t dataLength, bool isSymmetric = false);
72
73 /**
74 * Generate a symmetric key.
75 * @param keyName The name of the key.
76 * @param keyType The type of the key, e.g. KEY_TYPE_AES.
77 * @param keySize The size of the key.
78 */
79 virtual void
80 generateKey(const Name& keyName, KeyType keyType = KEY_TYPE_AES, int keySize = 256);
81
82 /**
83 * Check if a particular key exists.
84 * @param keyName The name of the key.
85 * @param keyClass The class of the key, e.g. KEY_CLASS_PUBLIC, KEY_CLASS_PRIVATE, or KEY_CLASS_SYMMETRIC.
86 * @return True if the key exists, otherwise false.
87 */
88 virtual bool
89 doesKeyExist(const Name& keyName, KeyClass keyClass);
90
Alexander Afanasyev04b22a92014-01-05 22:40:17 -080091
92 ////////////////////////////////////////////////////////////////////////////////////
93 // OSX-specifics
94 ////////////////////////////////////////////////////////////////////////////////////
95
Jeff Thompson2747dc02013-10-04 19:11:34 -070096 /**
97 * configure ACL of a particular key
98 * @param keyName the name of key
99 * @param keyClass the class of key, e.g. Private Key
100 * @param acl the new acl of the key
101 * @param appPath the absolute path to the application
102 * @returns true if setting succeeds
103 */
104 bool
105 setACL(const Name & keyName, KeyClass keyClass, int acl, const std::string & appPath);
106
Alexander Afanasyev04b22a92014-01-05 22:40:17 -0800107 // /**
108 // * verify data (test only)
109 // * @param keyName the name of key
110 // * @param pData the data to be verified
111 // * @param pSig the signature associated with the data
112 // * @param digestAlgo digest algorithm
113 // * @return true if signature can be verified, otherwise false
114 // */
115 // bool
116 // verifyData(const Name & keyName, const Blob & pData, const Blob & pSig, DigestAlgorithm digestAlgo = DIGEST_ALGORITHM_SHA256);
Jeff Thompson2747dc02013-10-04 19:11:34 -0700117
118 private:
Alexander Afanasyev04b22a92014-01-05 22:40:17 -0800119 class Impl;
120 std::auto_ptr<Impl> impl_;
Jeff Thompson2747dc02013-10-04 19:11:34 -0700121};
122
123}
124
Jeff Thompsonc5647812013-10-11 18:06:38 -0700125#endif // NDN_CPP_HAVE_OSX_SECURITY
Jeff Thompson2747dc02013-10-04 19:11:34 -0700126
127#endif