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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
use std::io::{ErrorKind, Read, Write};
use std::{ffi::c_void, ptr::null};
use std::{ptr::null_mut, slice};
use libc::{size_t, EINVAL, EIO};
use pki_types::CertificateDer;
use rustls::CipherSuite::TLS_NULL_WITH_NULL_NULL;
use rustls::{ClientConnection, ServerConnection};
use crate::cipher::rustls_certificate;
use crate::error::{map_error, rustls_io_result, rustls_result};
use crate::io::{
rustls_read_callback, rustls_write_callback, rustls_write_vectored_callback, CallbackReader,
CallbackWriter, VectoredCallbackWriter,
};
use crate::log::{ensure_log_registered, rustls_log_callback};
use crate::rslice::rustls_str;
use crate::{
box_castable, ffi_panic_boundary, free_box, try_callback, try_mut_from_ptr, try_ref_from_ptr,
try_slice, try_slice_mut, userdata_push,
};
use rustls_result::NullParameter;
pub(crate) struct Connection {
conn: rustls::Connection,
userdata: *mut c_void,
log_callback: rustls_log_callback,
}
impl Connection {
pub(crate) fn from_client(conn: ClientConnection) -> Self {
Connection {
conn: conn.into(),
userdata: null_mut(),
log_callback: None,
}
}
pub(crate) fn from_server(conn: ServerConnection) -> Self {
Connection {
conn: conn.into(),
userdata: null_mut(),
log_callback: None,
}
}
#[allow(dead_code)]
pub(crate) fn as_client(&self) -> Option<&ClientConnection> {
match &self.conn {
rustls::Connection::Client(c) => Some(c),
_ => None,
}
}
pub(crate) fn as_server(&self) -> Option<&ServerConnection> {
match &self.conn {
rustls::Connection::Server(s) => Some(s),
_ => None,
}
}
#[allow(dead_code)]
pub(crate) fn as_client_mut(&mut self) -> Option<&mut ClientConnection> {
match &mut self.conn {
rustls::Connection::Client(c) => Some(c),
_ => None,
}
}
#[allow(dead_code)]
pub(crate) fn as_server_mut(&mut self) -> Option<&mut ServerConnection> {
match &mut self.conn {
rustls::Connection::Server(s) => Some(s),
_ => None,
}
}
}
impl std::ops::Deref for Connection {
type Target = rustls::Connection;
fn deref(&self) -> &Self::Target {
&self.conn
}
}
impl std::ops::DerefMut for Connection {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.conn
}
}
box_castable! {
pub struct rustls_connection(Connection);
}
impl rustls_connection {
/// Set the userdata pointer associated with this connection. This will be passed
/// to any callbacks invoked by the connection, if you've set up callbacks in the config.
/// The pointed-to data must outlive the connection.
#[no_mangle]
pub extern "C" fn rustls_connection_set_userdata(
conn: *mut rustls_connection,
userdata: *mut c_void,
) {
let conn = try_mut_from_ptr!(conn);
conn.userdata = userdata;
}
/// Set the logging callback for this connection. The log callback will be invoked
/// with the userdata parameter previously set by rustls_connection_set_userdata, or
/// NULL if no userdata was set.
#[no_mangle]
pub extern "C" fn rustls_connection_set_log_callback(
conn: *mut rustls_connection,
cb: rustls_log_callback,
) {
let conn = try_mut_from_ptr!(conn);
ensure_log_registered();
conn.log_callback = cb;
}
/// Read some TLS bytes from the network into internal buffers. The actual network
/// I/O is performed by `callback`, which you provide. Rustls will invoke your
/// callback with a suitable buffer to store the read bytes into. You don't have
/// to fill it up, just fill with as many bytes as you get in one syscall.
/// The `userdata` parameter is passed through directly to `callback`. Note that
/// this is distinct from the `userdata` parameter set with
/// `rustls_connection_set_userdata`.
/// Returns 0 for success, or an errno value on error. Passes through return values
/// from callback. See rustls_read_callback for more details.
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.read_tls>
#[no_mangle]
pub extern "C" fn rustls_connection_read_tls(
conn: *mut rustls_connection,
callback: rustls_read_callback,
userdata: *mut c_void,
out_n: *mut size_t,
) -> rustls_io_result {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
if out_n.is_null() {
return rustls_io_result(EINVAL);
}
let callback = try_callback!(callback);
let mut reader = CallbackReader { callback, userdata };
let n_read = match conn.read_tls(&mut reader) {
Ok(n) => n,
Err(e) => return rustls_io_result(e.raw_os_error().unwrap_or(EIO)),
};
unsafe {
*out_n = n_read;
}
rustls_io_result(0)
}
}
/// Write some TLS bytes to the network. The actual network I/O is performed by
/// `callback`, which you provide. Rustls will invoke your callback with a
/// suitable buffer containing TLS bytes to send. You don't have to write them
/// all, just as many as you can in one syscall.
/// The `userdata` parameter is passed through directly to `callback`. Note that
/// this is distinct from the `userdata` parameter set with
/// `rustls_connection_set_userdata`.
/// Returns 0 for success, or an errno value on error. Passes through return values
/// from callback. See rustls_write_callback for more details.
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.write_tls>
#[no_mangle]
pub extern "C" fn rustls_connection_write_tls(
conn: *mut rustls_connection,
callback: rustls_write_callback,
userdata: *mut c_void,
out_n: *mut size_t,
) -> rustls_io_result {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
if out_n.is_null() {
return rustls_io_result(EINVAL);
}
let callback = try_callback!(callback);
let mut writer = CallbackWriter { callback, userdata };
let n_written = match conn.write_tls(&mut writer) {
Ok(n) => n,
Err(e) => return rustls_io_result(e.raw_os_error().unwrap_or(EIO)),
};
unsafe {
*out_n = n_written;
}
rustls_io_result(0)
}
}
/// Write all available TLS bytes to the network. The actual network I/O is performed by
/// `callback`, which you provide. Rustls will invoke your callback with an array
/// of rustls_slice_bytes, each containing a buffer with TLS bytes to send.
/// You don't have to write them all, just as many as you are willing.
/// The `userdata` parameter is passed through directly to `callback`. Note that
/// this is distinct from the `userdata` parameter set with
/// `rustls_connection_set_userdata`.
/// Returns 0 for success, or an errno value on error. Passes through return values
/// from callback. See rustls_write_callback for more details.
/// <https://docs.rs/rustls/latest/rustls/struct.Writer.html#method.write_vectored>
#[no_mangle]
pub extern "C" fn rustls_connection_write_tls_vectored(
conn: *mut rustls_connection,
callback: rustls_write_vectored_callback,
userdata: *mut c_void,
out_n: *mut size_t,
) -> rustls_io_result {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
if out_n.is_null() {
return rustls_io_result(EINVAL);
}
let callback = try_callback!(callback);
let mut writer = VectoredCallbackWriter { callback, userdata };
let n_written = match conn.write_tls(&mut writer) {
Ok(n) => n,
Err(e) => return rustls_io_result(e.raw_os_error().unwrap_or(EIO)),
};
unsafe {
*out_n = n_written;
}
rustls_io_result(0)
}
}
/// Decrypt any available ciphertext from the internal buffer and put it
/// into the internal plaintext buffer, potentially making bytes available
/// for rustls_connection_read().
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.process_new_packets>
#[no_mangle]
pub extern "C" fn rustls_connection_process_new_packets(
conn: *mut rustls_connection,
) -> rustls_result {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
let guard = match userdata_push(conn.userdata, conn.log_callback) {
Ok(g) => g,
Err(_) => return rustls_result::Panic,
};
let result = match conn.process_new_packets() {
Ok(_) => rustls_result::Ok,
Err(e) => map_error(e),
};
match guard.try_drop() {
Ok(()) => result,
Err(_) => rustls_result::Panic,
}
}
}
/// <https://docs.rs/rustls/latest/rustls/struct.CommonState.html#method.wants_read>
#[no_mangle]
pub extern "C" fn rustls_connection_wants_read(conn: *const rustls_connection) -> bool {
ffi_panic_boundary! {
let conn = try_ref_from_ptr!(conn);
conn.wants_read()
}
}
/// <https://docs.rs/rustls/latest/rustls/struct.CommonState.html#method.wants_write>
#[no_mangle]
pub extern "C" fn rustls_connection_wants_write(conn: *const rustls_connection) -> bool {
ffi_panic_boundary! {
let conn = try_ref_from_ptr!(conn);
conn.wants_write()
}
}
/// Returns true if the connection is currently performing the TLS handshake.
///
/// Note: This may return `false` while there are still handshake packets waiting
/// to be extracted and transmitted with `rustls_connection_write_tls()`.
///
/// See the rustls documentation for more information.
///
/// <https://docs.rs/rustls/latest/rustls/struct.CommonState.html#method.is_handshaking>
#[no_mangle]
pub extern "C" fn rustls_connection_is_handshaking(conn: *const rustls_connection) -> bool {
ffi_panic_boundary! {
let conn = try_ref_from_ptr!(conn);
conn.is_handshaking()
}
}
/// Sets a limit on the internal buffers used to buffer unsent plaintext (prior
/// to completing the TLS handshake) and unsent TLS records. By default, there
/// is no limit. The limit can be set at any time, even if the current buffer
/// use is higher.
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.set_buffer_limit>
#[no_mangle]
pub extern "C" fn rustls_connection_set_buffer_limit(conn: *mut rustls_connection, n: usize) {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
conn.set_buffer_limit(Some(n));
}
}
/// Queues a close_notify fatal alert to be sent in the next write_tls call.
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.send_close_notify>
#[no_mangle]
pub extern "C" fn rustls_connection_send_close_notify(conn: *mut rustls_connection) {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
conn.send_close_notify();
}
}
/// Return the i-th certificate provided by the peer.
/// Index 0 is the end entity certificate. Higher indexes are certificates
/// in the chain. Requesting an index higher than what is available returns
/// NULL.
/// The returned pointer is valid until the next mutating function call
/// affecting the connection. A mutating function call is one where the
/// first argument has type `struct rustls_connection *` (as opposed to
/// `const struct rustls_connection *`).
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.peer_certificates>
#[no_mangle]
pub extern "C" fn rustls_connection_get_peer_certificate<'a>(
conn: *const rustls_connection,
i: size_t,
) -> *const rustls_certificate<'a> {
ffi_panic_boundary! {
let conn = try_ref_from_ptr!(conn);
match conn.peer_certificates().and_then(|c| c.get(i)) {
Some(cert) => cert as *const CertificateDer as *const _,
None => null(),
}
}
}
/// Get the ALPN protocol that was negotiated, if any. Stores a pointer to a
/// borrowed buffer of bytes, and that buffer's len, in the output parameters.
/// The borrow lives as long as the connection.
/// If the connection is still handshaking, or no ALPN protocol was negotiated,
/// stores NULL and 0 in the output parameters.
/// The provided pointer is valid until the next mutating function call
/// affecting the connection. A mutating function call is one where the
/// first argument has type `struct rustls_connection *` (as opposed to
/// `const struct rustls_connection *`).
/// <https://www.iana.org/assignments/tls-parameters/>
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.alpn_protocol>
#[no_mangle]
pub extern "C" fn rustls_connection_get_alpn_protocol(
conn: *const rustls_connection,
protocol_out: *mut *const u8,
protocol_out_len: *mut usize,
) {
ffi_panic_boundary! {
let conn = try_ref_from_ptr!(conn);
if protocol_out.is_null() || protocol_out_len.is_null() {
return;
}
match conn.alpn_protocol() {
Some(p) => unsafe {
*protocol_out = p.as_ptr();
*protocol_out_len = p.len();
},
None => unsafe {
*protocol_out = null();
*protocol_out_len = 0;
},
}
}
}
/// Return the TLS protocol version that has been negotiated. Before this
/// has been decided during the handshake, this will return 0. Otherwise,
/// the u16 version number as defined in the relevant RFC is returned.
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.protocol_version>
/// <https://docs.rs/rustls/latest/rustls/internal/msgs/enums/enum.ProtocolVersion.html>
#[no_mangle]
pub extern "C" fn rustls_connection_get_protocol_version(
conn: *const rustls_connection,
) -> u16 {
ffi_panic_boundary! {
let conn = try_ref_from_ptr!(conn);
match conn.protocol_version() {
Some(p) => u16::from(p),
_ => 0,
}
}
}
/// Retrieves the [IANA registered cipher suite identifier][IANA] agreed with the peer.
///
/// This returns `TLS_NULL_WITH_NULL_NULL` (0x0000) until the ciphersuite is agreed.
///
/// [IANA]: <https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4>
#[no_mangle]
pub extern "C" fn rustls_connection_get_negotiated_ciphersuite(
conn: *const rustls_connection,
) -> u16 {
ffi_panic_boundary! {
match try_ref_from_ptr!(conn).negotiated_cipher_suite() {
Some(cs) => u16::from(cs.suite()),
None => u16::from(TLS_NULL_WITH_NULL_NULL),
}
}
}
/// Retrieves the cipher suite name agreed with the peer.
///
/// This returns "" until the ciphersuite is agreed.
///
/// The lifetime of the `rustls_str` is the lifetime of the program, it does not
/// need to be freed.
///
/// <https://docs.rs/rustls/latest/rustls/enum.Connection.html#method.negotiated_cipher_suite>
#[no_mangle]
pub extern "C" fn rustls_connection_get_negotiated_ciphersuite_name(
conn: *const rustls_connection,
) -> rustls_str<'static> {
ffi_panic_boundary! {
let cs_name = try_ref_from_ptr!(conn)
.negotiated_cipher_suite()
.and_then(|cs| cs.suite().as_str())
.and_then(|name| rustls_str::try_from(name).ok());
match cs_name {
Some(cs) => cs,
None => rustls_str::from_str_unchecked(""),
}
}
}
/// Write up to `count` plaintext bytes from `buf` into the `rustls_connection`.
/// This will increase the number of output bytes available to
/// `rustls_connection_write_tls`.
/// On success, store the number of bytes actually written in *out_n
/// (this may be less than `count`).
/// <https://docs.rs/rustls/latest/rustls/struct.Writer.html#method.write>
#[no_mangle]
pub extern "C" fn rustls_connection_write(
conn: *mut rustls_connection,
buf: *const u8,
count: size_t,
out_n: *mut size_t,
) -> rustls_result {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
let write_buf = try_slice!(buf, count);
if out_n.is_null() {
return NullParameter;
}
let n_written = match conn.writer().write(write_buf) {
Ok(n) => n,
Err(_) => return rustls_result::Io,
};
unsafe {
*out_n = n_written;
}
rustls_result::Ok
}
}
/// Read up to `count` plaintext bytes from the `rustls_connection` into `buf`.
/// On success, store the number of bytes read in *out_n (this may be less
/// than `count`). A success with *out_n set to 0 means "all bytes currently
/// available have been read, but more bytes may become available after
/// subsequent calls to rustls_connection_read_tls and
/// rustls_connection_process_new_packets."
///
/// Subtle note: Even though this function only writes to `buf` and does not
/// read from it, the memory in `buf` must be initialized before the call (for
/// Rust-internal reasons). Initializing a buffer once and then using it
/// multiple times without zeroizing before each call is fine.
/// <https://docs.rs/rustls/latest/rustls/struct.Reader.html#method.read>
#[no_mangle]
pub extern "C" fn rustls_connection_read(
conn: *mut rustls_connection,
buf: *mut u8,
count: size_t,
out_n: *mut size_t,
) -> rustls_result {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
if buf.is_null() {
return NullParameter;
}
if out_n.is_null() {
return NullParameter;
}
// Safety: the memory pointed at by buf must be initialized
// (required by documentation of this function).
let read_buf = try_slice_mut!(buf, count);
let n_read = match conn.reader().read(read_buf) {
Ok(n) => n,
Err(e) if e.kind() == ErrorKind::UnexpectedEof => {
return rustls_result::UnexpectedEof
}
Err(e) if e.kind() == ErrorKind::WouldBlock => {
return rustls_result::PlaintextEmpty
}
Err(_) => return rustls_result::Io,
};
unsafe {
*out_n = n_read;
}
rustls_result::Ok
}
}
/// Read up to `count` plaintext bytes from the `rustls_connection` into `buf`.
/// On success, store the number of bytes read in *out_n (this may be less
/// than `count`). A success with *out_n set to 0 means "all bytes currently
/// available have been read, but more bytes may become available after
/// subsequent calls to rustls_connection_read_tls and
/// rustls_connection_process_new_packets."
///
/// This experimental API is only available when using a nightly Rust compiler
/// and enabling the `read_buf` Cargo feature. It will be deprecated and later
/// removed in future versions.
///
/// Unlike with `rustls_connection_read`, this function may be called with `buf`
/// pointing to an uninitialized memory buffer.
#[cfg(feature = "read_buf")]
#[no_mangle]
pub extern "C" fn rustls_connection_read_2(
conn: *mut rustls_connection,
buf: *mut std::mem::MaybeUninit<u8>,
count: size_t,
out_n: *mut size_t,
) -> rustls_result {
ffi_panic_boundary! {
let conn = try_mut_from_ptr!(conn);
if buf.is_null() || out_n.is_null() {
return NullParameter;
}
let mut read_buf: std::io::BorrowedBuf<'_> = try_slice_mut!(buf, count).into();
let n_read = match conn.reader().read_buf(read_buf.unfilled()) {
Ok(()) => read_buf.filled().len(),
Err(e) if e.kind() == ErrorKind::UnexpectedEof => {
return rustls_result::UnexpectedEof
}
Err(e) if e.kind() == ErrorKind::WouldBlock => {
return rustls_result::PlaintextEmpty
}
Err(_) => return rustls_result::Io,
};
unsafe {
*out_n = n_read;
}
rustls_result::Ok
}
}
/// Free a rustls_connection. Calling with NULL is fine.
/// Must not be called twice with the same value.
#[no_mangle]
pub extern "C" fn rustls_connection_free(conn: *mut rustls_connection) {
ffi_panic_boundary! {
free_box(conn);
}
}
}