xref: /freebsd/contrib/libarchive/libarchive/archive_cryptor_private.h (revision 2e113ef82465598b8c26e0ca415fbe90677fbd47)
1 /*-
2 * Copyright (c) 2014 Michihiro NAKAJIMA
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25 
26 #ifndef ARCHIVE_CRYPTOR_PRIVATE_H_INCLUDED
27 #define ARCHIVE_CRYPTOR_PRIVATE_H_INCLUDED
28 
29 #ifndef __LIBARCHIVE_BUILD
30 #error This header is only to be used internally to libarchive.
31 #endif
32 /*
33  * On systems that do not support any recognized crypto libraries,
34  * the archive_cryptor.c file will normally define no usable symbols.
35  *
36  * But some compilers and linkers choke on empty object files, so
37  * define a public symbol that will always exist.  This could
38  * be removed someday if this file gains another always-present
39  * symbol definition.
40  */
41 int __libarchive_cryptor_build_hack(void);
42 
43 #ifdef __APPLE__
44 # include <AvailabilityMacros.h>
45 # if MAC_OS_X_VERSION_MAX_ALLOWED >= 1080
46 #  define ARCHIVE_CRYPTOR_USE_Apple_CommonCrypto
47 # endif
48 #endif
49 
50 #ifdef ARCHIVE_CRYPTOR_USE_Apple_CommonCrypto
51 #include <CommonCrypto/CommonCryptor.h>
52 #include <CommonCrypto/CommonKeyDerivation.h>
53 #define AES_BLOCK_SIZE	16
54 #define AES_MAX_KEY_SIZE kCCKeySizeAES256
55 
56 typedef struct {
57 	CCCryptorRef	ctx;
58 	uint8_t		key[AES_MAX_KEY_SIZE];
59 	unsigned	key_len;
60 	uint8_t		nonce[AES_BLOCK_SIZE];
61 	uint8_t		encr_buf[AES_BLOCK_SIZE];
62 	unsigned	encr_pos;
63 } archive_crypto_ctx;
64 
65 #elif defined(_WIN32) && !defined(__CYGWIN__) && defined(HAVE_BCRYPT_H) && _WIN32_WINNT >= _WIN32_WINNT_VISTA
66 #include <bcrypt.h>
67 #define	ARCHIVE_CRYPTOR_USE_CNG 1
68 
69 /* Common in other bcrypt implementations, but missing from VS2008. */
70 #ifndef BCRYPT_SUCCESS
71 #define BCRYPT_SUCCESS(r) ((NTSTATUS)(r) == STATUS_SUCCESS)
72 #endif
73 
74 #define AES_MAX_KEY_SIZE 32
75 #define AES_BLOCK_SIZE 16
76 typedef struct {
77 	BCRYPT_ALG_HANDLE hAlg;
78 	BCRYPT_KEY_HANDLE hKey;
79 	PBYTE		keyObj;
80 	DWORD		keyObj_len;
81 	uint8_t		nonce[AES_BLOCK_SIZE];
82 	uint8_t		encr_buf[AES_BLOCK_SIZE];
83 	unsigned	encr_pos;
84 } archive_crypto_ctx;
85 
86 #elif defined(HAVE_LIBMBEDCRYPTO) && defined(HAVE_MBEDTLS_AES_H)
87 #include <mbedtls/aes.h>
88 #include <mbedtls/md.h>
89 #include <mbedtls/pkcs5.h>
90 #define	ARCHIVE_CRYPTOR_USE_MBED 1
91 
92 #define AES_MAX_KEY_SIZE 32
93 #define AES_BLOCK_SIZE 16
94 
95 typedef struct {
96 	mbedtls_aes_context	ctx;
97 	uint8_t		key[AES_MAX_KEY_SIZE];
98 	unsigned	key_len;
99 	uint8_t		nonce[AES_BLOCK_SIZE];
100 	uint8_t		encr_buf[AES_BLOCK_SIZE];
101 	unsigned	encr_pos;
102 } archive_crypto_ctx;
103 
104 #elif defined(HAVE_LIBNETTLE) && defined(HAVE_NETTLE_AES_H)
105 #if defined(HAVE_NETTLE_PBKDF2_H)
106 #include <nettle/pbkdf2.h>
107 #endif
108 #include <nettle/aes.h>
109 #include <nettle/version.h>
110 #define	ARCHIVE_CRYPTOR_USE_NETTLE 1
111 
112 typedef struct {
113 #if NETTLE_VERSION_MAJOR < 3
114 	struct aes_ctx	ctx;
115 #else
116 	union {
117 		struct aes128_ctx c128;
118 		struct aes192_ctx c192;
119 		struct aes256_ctx c256;
120 	}		ctx;
121 #endif
122 	uint8_t		key[AES_MAX_KEY_SIZE];
123 	unsigned	key_len;
124 	uint8_t		nonce[AES_BLOCK_SIZE];
125 	uint8_t		encr_buf[AES_BLOCK_SIZE];
126 	unsigned	encr_pos;
127 } archive_crypto_ctx;
128 
129 #elif defined(HAVE_LIBCRYPTO)
130 #include "archive_openssl_evp_private.h"
131 #define	ARCHIVE_CRYPTOR_USE_OPENSSL 1
132 #define AES_BLOCK_SIZE	16
133 #define AES_MAX_KEY_SIZE 32
134 
135 typedef struct {
136 	EVP_CIPHER_CTX	*ctx;
137 	const EVP_CIPHER *type;
138 	uint8_t		key[AES_MAX_KEY_SIZE];
139 	unsigned	key_len;
140 	uint8_t		nonce[AES_BLOCK_SIZE];
141 	uint8_t		encr_buf[AES_BLOCK_SIZE];
142 	unsigned	encr_pos;
143 } archive_crypto_ctx;
144 
145 #else
146 
147 #if defined(_WIN32) && !defined(__CYGWIN__) && !(defined(HAVE_BCRYPT_H) && _WIN32_WINNT >= _WIN32_WINNT_VISTA)
148 #define ARCHIVE_CRYPTOR_USE_WINCRYPT 1
149 #endif
150 
151 #define AES_BLOCK_SIZE	16
152 #define AES_MAX_KEY_SIZE 32
153 typedef int archive_crypto_ctx;
154 
155 #endif
156 
157 /* defines */
158 #define archive_pbkdf2_sha1(pw, pw_len, salt, salt_len, rounds, dk, dk_len)\
159   __archive_cryptor.pbkdf2sha1(pw, pw_len, salt, salt_len, rounds, dk, dk_len)
160 
161 #define archive_decrypto_aes_ctr_init(ctx, key, key_len) \
162   __archive_cryptor.decrypto_aes_ctr_init(ctx, key, key_len)
163 #define archive_decrypto_aes_ctr_update(ctx, in, in_len, out, out_len) \
164   __archive_cryptor.decrypto_aes_ctr_update(ctx, in, in_len, out, out_len)
165 #define archive_decrypto_aes_ctr_release(ctx) \
166   __archive_cryptor.decrypto_aes_ctr_release(ctx)
167 
168 #define archive_encrypto_aes_ctr_init(ctx, key, key_len) \
169   __archive_cryptor.encrypto_aes_ctr_init(ctx, key, key_len)
170 #define archive_encrypto_aes_ctr_update(ctx, in, in_len, out, out_len) \
171   __archive_cryptor.encrypto_aes_ctr_update(ctx, in, in_len, out, out_len)
172 #define archive_encrypto_aes_ctr_release(ctx) \
173   __archive_cryptor.encrypto_aes_ctr_release(ctx)
174 
175 /* Minimal interface to cryptographic functionality for internal use in
176  * libarchive */
177 struct archive_cryptor
178 {
179   /* PKCS5 PBKDF2 HMAC-SHA1 */
180   int (*pbkdf2sha1)(const char *pw, size_t pw_len, const uint8_t *salt,
181     size_t salt_len, unsigned rounds, uint8_t *derived_key,
182     size_t derived_key_len);
183   /* AES CTR mode(little endian version) */
184   int (*decrypto_aes_ctr_init)(archive_crypto_ctx *, const uint8_t *, size_t);
185   int (*decrypto_aes_ctr_update)(archive_crypto_ctx *, const uint8_t *,
186     size_t, uint8_t *, size_t *);
187   int (*decrypto_aes_ctr_release)(archive_crypto_ctx *);
188   int (*encrypto_aes_ctr_init)(archive_crypto_ctx *, const uint8_t *, size_t);
189   int (*encrypto_aes_ctr_update)(archive_crypto_ctx *, const uint8_t *,
190     size_t, uint8_t *, size_t *);
191   int (*encrypto_aes_ctr_release)(archive_crypto_ctx *);
192 };
193 
194 extern const struct archive_cryptor __archive_cryptor;
195 
196 #endif
197