1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
//! Schannel credentials.
use winapi::shared::{sspi, winerror};
use winapi::shared::minwindef as winapi;
use winapi::um::{self, wincrypt};
use std::io;
use std::mem;
use std::ptr;
use Inner;
use cert_context::CertContext;
lazy_static! {
static ref UNISP_NAME: Vec<u8> = um::schannel::UNISP_NAME.bytes().chain(Some(0)).collect();
}
/// The communication direction that an `SchannelCred` will support.
#[derive(Copy, Debug, Clone, PartialEq, Eq)]
pub enum Direction {
/// Server-side, inbound connections.
Inbound,
/// Client-side, outbound connections.
Outbound,
}
/// Algorithms supported by Schannel.
// https://msdn.microsoft.com/en-us/library/windows/desktop/aa375549(v=vs.85).aspx
#[derive(Debug, Copy, Clone)]
#[repr(u32)]
pub enum Algorithm {
/// Advanced Encryption Standard (AES).
Aes = wincrypt::CALG_AES,
/// 128 bit AES.
Aes128 = wincrypt::CALG_AES_128,
/// 192 bit AES.
Aes192 = wincrypt::CALG_AES_192,
/// 256 bit AES.
Aes256 = wincrypt::CALG_AES_256,
/// Temporary algorithm identifier for handles of Diffie-Hellman–agreed keys.
AgreedkeyAny = wincrypt::CALG_AGREEDKEY_ANY,
/// An algorithm to create a 40-bit DES key that has parity bits and zeroed key bits to make
/// its key length 64 bits.
CylinkMek = wincrypt::CALG_CYLINK_MEK,
/// DES encryption algorithm.
Des = wincrypt::CALG_DES,
/// DESX encryption algorithm.
Desx = wincrypt::CALG_DESX,
/// Diffie-Hellman ephemeral key exchange algorithm.
DhEphem = wincrypt::CALG_DH_EPHEM,
/// Diffie-Hellman store and forward key exchange algorithm.
DhSf = wincrypt::CALG_DH_SF,
/// DSA public key signature algorithm.
DssSign = wincrypt::CALG_DSS_SIGN,
/// Elliptic curve Diffie-Hellman key exchange algorithm.
Ecdh = wincrypt::CALG_ECDH,
// https://github.com/retep998/wincrypt-rs/issues/287
// /// Ephemeral elliptic curve Diffie-Hellman key exchange algorithm.
// EcdhEphem = wincrypt::CALG_ECDH_EPHEM,
/// Elliptic curve digital signature algorithm.
Ecdsa = wincrypt::CALG_ECDSA,
/// One way function hashing algorithm.
HashReplaceOwf = wincrypt::CALG_HASH_REPLACE_OWF,
/// Hughes MD5 hashing algorithm.
HughesMd5 = wincrypt::CALG_HUGHES_MD5,
/// HMAC keyed hash algorithm.
Hmac = wincrypt::CALG_HMAC,
/// MAC keyed hash algorithm.
Mac = wincrypt::CALG_MAC,
/// MD2 hashing algorithm.
Md2 = wincrypt::CALG_MD2,
/// MD4 hashing algorithm.
Md4 = wincrypt::CALG_MD4,
/// MD5 hashing algorithm.
Md5 = wincrypt::CALG_MD5,
/// No signature algorithm..
NoSign = wincrypt::CALG_NO_SIGN,
/// RC2 block encryption algorithm.
Rc2 = wincrypt::CALG_RC2,
/// RC4 stream encryption algorithm.
Rc4 = wincrypt::CALG_RC4,
/// RC5 block encryption algorithm.
Rc5 = wincrypt::CALG_RC5,
/// RSA public key exchange algorithm.
RsaKeyx = wincrypt::CALG_RSA_KEYX,
/// RSA public key signature algorithm.
RsaSign = wincrypt::CALG_RSA_SIGN,
/// SHA hashing algorithm.
Sha1 = wincrypt::CALG_SHA1,
/// 256 bit SHA hashing algorithm.
Sha256 = wincrypt::CALG_SHA_256,
/// 384 bit SHA hashing algorithm.
Sha384 = wincrypt::CALG_SHA_384,
/// 512 bit SHA hashing algorithm.
Sha512 = wincrypt::CALG_SHA_512,
/// Triple DES encryption algorithm.
TripleDes = wincrypt::CALG_3DES,
/// Two-key triple DES encryption with effective key length equal to 112 bits.
TripleDes112 = wincrypt::CALG_3DES_112,
#[doc(hidden)]
__ForExtensibility,
}
/// Protocols supported by Schannel.
#[derive(Debug, Copy, Clone)]
pub enum Protocol {
/// Secure Sockets Layer 3.0
Ssl3,
/// Transport Layer Security 1.0
Tls10,
/// Transport Layer Security 1.1
Tls11,
/// Transport Layer Security 1.2
Tls12,
#[doc(hidden)]
__ForExtensibility,
}
impl Protocol {
fn dword(self, direction: Direction) -> winapi::DWORD {
match (self, direction) {
(Protocol::Ssl3, Direction::Inbound) => um::schannel::SP_PROT_SSL3_SERVER,
(Protocol::Tls10, Direction::Inbound) => um::schannel::SP_PROT_TLS1_0_SERVER,
(Protocol::Tls11, Direction::Inbound) => um::schannel::SP_PROT_TLS1_1_SERVER,
(Protocol::Tls12, Direction::Inbound) => um::schannel::SP_PROT_TLS1_2_SERVER,
(Protocol::Ssl3, Direction::Outbound) => um::schannel::SP_PROT_SSL3_CLIENT,
(Protocol::Tls10, Direction::Outbound) => um::schannel::SP_PROT_TLS1_0_CLIENT,
(Protocol::Tls11, Direction::Outbound) => um::schannel::SP_PROT_TLS1_1_CLIENT,
(Protocol::Tls12, Direction::Outbound) => um::schannel::SP_PROT_TLS1_2_CLIENT,
(Protocol::__ForExtensibility, _) => unreachable!(),
}
}
}
/// A builder type for `SchannelCred`s.
#[derive(Default, Debug)]
pub struct Builder {
supported_algorithms: Option<Vec<Algorithm>>,
enabled_protocols: Option<Vec<Protocol>>,
certs: Vec<CertContext>,
}
impl Builder {
/// Returns a new `Builder`.
pub fn new() -> Builder {
Builder::default()
}
/// Sets the algorithms supported for credentials created from this builder.
pub fn supported_algorithms(&mut self,
supported_algorithms: &[Algorithm])
-> &mut Builder {
assert!(supported_algorithms.iter()
.all(|a| {
match *a {
Algorithm::__ForExtensibility => false,
_ => true,
}
}));
self.supported_algorithms = Some(supported_algorithms.to_owned());
self
}
/// Sets the protocols enabled for credentials created from this builder.
pub fn enabled_protocols(&mut self,
enabled_protocols: &[Protocol])
-> &mut Builder {
assert!(enabled_protocols.iter()
.all(|a| {
match *a {
Protocol::__ForExtensibility => false,
_ => true,
}
}));
self.enabled_protocols = Some(enabled_protocols.to_owned());
self
}
/// Add a certificate to get passed down when the credentials are acquired.
///
/// Certificates passed here may specify a certificate that contains a
/// private key to be used in authenticating the application. Typically,
/// this is called once for each key exchange method supported by
/// servers.
///
/// Clients often do not call this function and either depend on Schannel to
/// find an appropriate certificate or create a certificate later if needed.
pub fn cert(&mut self, cx: CertContext) -> &mut Builder {
self.certs.push(cx);
self
}
/// Creates a new `SchannelCred`.
pub fn acquire(&self, direction: Direction) -> io::Result<SchannelCred> {
unsafe {
let mut handle = mem::zeroed();
let mut cred_data: um::schannel::SCHANNEL_CRED = mem::zeroed();
cred_data.dwVersion = um::schannel::SCHANNEL_CRED_VERSION;
cred_data.dwFlags = um::schannel::SCH_USE_STRONG_CRYPTO | um::schannel::SCH_CRED_NO_DEFAULT_CREDS;
if let Some(ref supported_algorithms) = self.supported_algorithms {
cred_data.cSupportedAlgs = supported_algorithms.len() as winapi::DWORD;
cred_data.palgSupportedAlgs = supported_algorithms.as_ptr() as *mut _;
}
if let Some(ref enabled_protocols) = self.enabled_protocols {
cred_data.grbitEnabledProtocols = enabled_protocols.iter()
.map(|p| p.dword(direction))
.fold(0, |acc, p| acc | p);
}
let mut certs = self.certs.iter().map(|c| c.as_inner()).collect::<Vec<_>>();
cred_data.cCreds = certs.len() as winapi::DWORD;
cred_data.paCred = certs.as_mut_ptr();
let direction = match direction {
Direction::Inbound => sspi::SECPKG_CRED_INBOUND,
Direction::Outbound => sspi::SECPKG_CRED_OUTBOUND,
};
match sspi::AcquireCredentialsHandleA(ptr::null_mut(),
UNISP_NAME.as_ptr() as *const _ as *mut _,
direction,
ptr::null_mut(),
&mut cred_data as *mut _ as *mut _,
None,
ptr::null_mut(),
&mut handle,
ptr::null_mut()) {
winerror::SEC_E_OK => Ok(SchannelCred(handle)),
err => Err(io::Error::from_raw_os_error(err as i32)),
}
}
}
}
/// An SChannel credential.
pub struct SchannelCred(sspi::CredHandle);
impl Drop for SchannelCred {
fn drop(&mut self) {
unsafe {
sspi::FreeCredentialsHandle(&mut self.0);
}
}
}
impl Inner<sspi::CredHandle> for SchannelCred {
unsafe fn from_inner(inner: sspi::CredHandle) -> SchannelCred {
SchannelCred(inner)
}
fn as_inner(&self) -> sspi::CredHandle {
self.0
}
fn get_mut(&mut self) -> &mut sspi::CredHandle {
&mut self.0
}
}
impl SchannelCred {
/// Returns a builder.
pub fn builder() -> Builder {
Builder::new()
}
}