Struct ntex::server::openssl::ssl::SslStream [−][src]
pub struct SslStream<S> { /* fields omitted */ }
Expand description
A TLS session over a stream.
Implementations
impl<S> SslStream<S> where
S: Read + Write,
[src]
impl<S> SslStream<S> where
S: Read + Write,
[src]pub fn new(ssl: Ssl, stream: S) -> Result<SslStream<S>, ErrorStack>
[src]
pub fn new(ssl: Ssl, stream: S) -> Result<SslStream<S>, ErrorStack>
[src]Creates a new SslStream
.
This function performs no IO; the stream will not have performed any part of the handshake
with the peer. If the Ssl
was configured with SslRef::set_connect_state
or
SslRef::set_accept_state
, the handshake can be performed automatically during the first
call to read or write. Otherwise the connect
and accept
methods can be used to
explicitly perform the handshake.
This corresponds to SSL_set_bio
.
pub unsafe fn from_raw_parts(ssl: *mut SSL, stream: S) -> SslStream<S>ⓘ
[src]
👎 Deprecated since 0.10.32: use Ssl::from_ptr and SslStream::new instead
pub unsafe fn from_raw_parts(ssl: *mut SSL, stream: S) -> SslStream<S>ⓘ
[src]use Ssl::from_ptr and SslStream::new instead
Constructs an SslStream
from a pointer to the underlying OpenSSL SSL
struct.
This is useful if the handshake has already been completed elsewhere.
Safety
The caller must ensure the pointer is valid.
pub fn read_early_data(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
pub fn read_early_data(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]Read application data transmitted by a client before handshake completion.
Useful for reducing latency, but vulnerable to replay attacks. Call
SslRef::set_accept_state
first.
Returns Ok(0)
if all early data has been read.
Requires OpenSSL 1.1.1 or newer.
This corresponds to SSL_read_early_data
.
pub fn write_early_data(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
pub fn write_early_data(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]Send data to the server without blocking on handshake completion.
Useful for reducing latency, but vulnerable to replay attacks. Call
SslRef::set_connect_state
first.
Requires OpenSSL 1.1.1 or newer.
This corresponds to SSL_write_early_data
.
pub fn connect(&mut self) -> Result<(), Error>
[src]
pub fn connect(&mut self) -> Result<(), Error>
[src]Initiates a client-side TLS handshake.
This corresponds to SSL_connect
.
Warning
OpenSSL’s default configuration is insecure. It is highly recommended to use
SslConnector
rather than Ssl
directly, as it manages that configuration.
pub fn accept(&mut self) -> Result<(), Error>
[src]
pub fn accept(&mut self) -> Result<(), Error>
[src]Initiates a server-side TLS handshake.
This corresponds to SSL_accept
.
Warning
OpenSSL’s default configuration is insecure. It is highly recommended to use
SslAcceptor
rather than Ssl
directly, as it manages that configuration.
pub fn do_handshake(&mut self) -> Result<(), Error>
[src]
pub fn do_handshake(&mut self) -> Result<(), Error>
[src]Initiates the handshake.
This will fail if set_accept_state
or set_connect_state
was not called first.
This corresponds to SSL_do_handshake
.
pub fn stateless(&mut self) -> Result<bool, ErrorStack>
[src]
pub fn stateless(&mut self) -> Result<bool, ErrorStack>
[src]Perform a stateless server-side handshake.
Requires that cookie generation and verification callbacks were set on the SSL context.
Returns Ok(true)
if a complete ClientHello containing a valid cookie
was read, in which case the handshake should be continued via
accept
. If a HelloRetryRequest containing a fresh cookie was
transmitted, Ok(false)
is returned instead. If the handshake cannot
proceed at all, Err
is returned.
This corresponds to SSL_stateless
pub fn ssl_read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
pub fn ssl_read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]Like read
, but returns an ssl::Error
rather than an io::Error
.
It is particularly useful with a nonblocking socket, where the error value will identify if OpenSSL is waiting on read or write readiness.
This corresponds to SSL_read
.
pub fn ssl_write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
pub fn ssl_write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]Like write
, but returns an ssl::Error
rather than an io::Error
.
It is particularly useful with a nonblocking socket, where the error value will identify if OpenSSL is waiting on read or write readiness.
This corresponds to SSL_write
.
pub fn shutdown(&mut self) -> Result<ShutdownResult, Error>
[src]
pub fn shutdown(&mut self) -> Result<ShutdownResult, Error>
[src]Shuts down the session.
The shutdown process consists of two steps. The first step sends a close notify message to
the peer, after which ShutdownResult::Sent
is returned. The second step awaits the receipt
of a close notify message from the peer, after which ShutdownResult::Received
is returned.
While the connection may be closed after the first step, it is recommended to fully shut the session down. In particular, it must be fully shut down if the connection is to be used for further communication in the future.
This corresponds to SSL_shutdown
.
pub fn get_shutdown(&mut self) -> ShutdownState
[src]
pub fn get_shutdown(&mut self) -> ShutdownState
[src]Returns the session’s shutdown state.
This corresponds to SSL_get_shutdown
.
pub fn set_shutdown(&mut self, state: ShutdownState)
[src]
pub fn set_shutdown(&mut self, state: ShutdownState)
[src]Sets the session’s shutdown state.
This can be used to tell OpenSSL that the session should be cached even if a full two-way shutdown was not completed.
This corresponds to SSL_set_shutdown
.
impl<S> SslStream<S>
[src]
impl<S> SslStream<S>
[src]Trait Implementations
impl<S> Read for SslStream<S> where
S: Read + Write,
[src]
impl<S> Read for SslStream<S> where
S: Read + Write,
[src]pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]Like read
, except that it reads into a slice of buffers. Read more
fn is_read_vectored(&self) -> bool
[src]
fn is_read_vectored(&self) -> bool
[src]can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
unsafe fn initializer(&self) -> Initializer
[src]
unsafe fn initializer(&self) -> Initializer
[src]read_initializer
)Determines if this Read
er can work with buffers of uninitialized
memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]Creates a “by reference” adaptor for this instance of Read
. Read more
impl<S> Write for SslStream<S> where
S: Read + Write,
[src]
impl<S> Write for SslStream<S> where
S: Read + Write,
[src]pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]Write a buffer into this writer, returning how many bytes were written. Read more
pub fn flush(&mut self) -> Result<(), Error>
[src]
pub fn flush(&mut self) -> Result<(), Error>
[src]Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn is_write_vectored(&self) -> bool
[src]
fn is_write_vectored(&self) -> bool
[src]can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]Attempts to write an entire buffer into this writer. Read more
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
[src]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
[src]write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations
impl<S> RefUnwindSafe for SslStream<S> where
S: RefUnwindSafe,
S: RefUnwindSafe,
impl<S> Send for SslStream<S> where
S: Send,
S: Send,
impl<S> Sync for SslStream<S> where
S: Sync,
S: Sync,
impl<S> Unpin for SslStream<S> where
S: Unpin,
S: Unpin,
impl<S> UnwindSafe for SslStream<S> where
S: UnwindSafe,
S: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self