A high-level class for communicating securely over a TCP socket, using TLS and SSL. The SecureSocket exposes both a Stream and an IOSink interface, making it ideal for using together with other Streams.
- Implements
Static Methods
-
connect(
host, int port, {bool sendClientCertificate: false, String certificateName, bool onBadCertificate(X509Certificate certificate), List<String> supportedProtocols}) → Future<SecureSocket> -
Constructs a new secure client socket and connect it to the given
host
on portport
. The returned Future will complete with a SecureSocket that is connected and ready for subscription. -
initialize(
{String database, String password, bool useBuiltinRoots: true}) → void - Initializes the NSS library. If initialize is not called, the library is automatically initialized as if initialize were called with no arguments. If initialize is called more than once, or called after automatic initialization has happened (when a secure connection is made), then a TlsException is thrown.
-
secure(
Socket socket, {host, bool sendClientCertificate: false, String certificateName, bool onBadCertificate(X509Certificate certificate)}) → Future<SecureSocket> -
Takes an already connected
socket
and starts client side TLS handshake to make the communication secure. When the returned future completes the SecureSocket has completed the TLS handshake. Using this function requires that the other end of the connection is prepared for TLS handshake. -
secureServer(
Socket socket, String certificateName, {List<int> bufferedData, bool requestClientCertificate: false, bool requireClientCertificate: false, List<String> supportedProtocols}) → Future<SecureSocket> -
Takes an already connected
socket
and starts server side TLS handshake to make the communication secure. When the returned future completes the SecureSocket has completed the TLS handshake. Using this function requires that the other end of the connection is going to start the TLS handshake.
Properties
- InternetAddress address
-
read-only, inheritedReturns the
InternetAddress
used to connect this socket. - Future done
-
read-only, inheritedGet a future that will complete when the consumer closes, or when an error occurs. This future is identical to the future returned by
close
. - Encoding encoding
-
read / write, inheritedThe Encoding used when writing strings. Depending on the underlying consumer this property might be mutable. /
- Future<List<int>> first
-
read-only, inheritedReturns the first element of the stream.
- bool isBroadcast
-
read-only, inheritedReports whether this stream is a broadcast stream.
- Future<bool> isEmpty
-
read-only, inheritedReports whether this stream contains any elements.
- Future<List<int>> last
-
read-only, inheritedReturns the last element of the stream.
- Future<int> length
-
read-only, inheritedCounts the elements in the stream.
- X509Certificate peerCertificate
-
read-onlyGet the peer certificate for a connected SecureSocket. If this SecureSocket is the server end of a secure socket connection,
peerCertificate
will return the client certificate, or null, if no client certificate was received. If it is the client end,peerCertificate
will return the server's certificate. - int port
-
read-only, inheritedReturns the port used by this socket.
- InternetAddress remoteAddress
-
read-only, inheritedReturns the remote
InternetAddress
connected to by this socket. - int remotePort
-
read-only, inheritedReturns the remote port connected to by this socket.
- String selectedProtocol
-
read-onlyGet the protocol which was selected during protocol negotiation.
- Future<List<int>> single
-
read-only, inheritedReturns the single element.
Methods
-
add(
List<int> data) → void -
inheritedAdds
data
to the target consumer, ignoring encoding. -
addError(
error, [StackTrace stackTrace]) → void -
inheritedPasses the error to the target consumer as an error event.
-
addStream(
Stream<List<int>> stream) → Future -
inheritedAdds all elements of the given
stream
tothis
. -
any(
bool test(T element)) → Future<bool> -
inheritedChecks whether
test
accepts any element provided by this stream. -
asBroadcastStream(
{void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)}) → Stream<List<int>> -
inheritedReturns a multi-subscription stream that produces the same events as this.
-
asyncExpand(
Stream convert(T event)) → Stream -
inheritedCreates a new stream with the events of a stream per original event.
-
asyncMap(
dynamic convert(T event)) → Stream -
inheritedCreates a new stream with each data event of this stream asynchronously mapped to a new event.
-
close(
) → Future -
inheritedClose the target consumer.
-
contains(
Object needle) → Future<bool> -
inheritedChecks whether
needle
occurs in the elements provided by this stream. -
destroy(
) → void -
inheritedDestroy the socket in both directions. Calling destroy will make the send a close event on the stream and will no longer react on data being piped to it.
-
distinct(
[bool equals(T previous, T next)]) → Stream<List<int>> -
inheritedSkips data events if they are equal to the previous data event.
-
drain(
[futureValue]) → Future -
inheritedDiscards all data on the stream, but signals when it's done or an error occured.
-
elementAt(
int index) → Future<List<int>> -
inheritedReturns the value of the
index
th data event of this stream. -
every(
bool test(T element)) → Future<bool> -
inheritedChecks whether
test
accepts all elements provided by this stream. -
expand(
Iterable convert(T value)) → Stream -
inheritedCreates a new stream from this stream that converts each element into zero or more events.
-
firstWhere(
bool test(T element), {Object defaultValue()}) → Future -
inheritedFinds the first element of this stream matching
test
. -
flush(
) → Future -
inheritedReturns a Future that completes once all buffered data is accepted by the to underlying StreamConsumer.
-
fold(
initialValue, dynamic combine(previous, T element)) → Future -
inheritedReduces a sequence of values by repeatedly applying
combine
. -
forEach(
void action(T element)) → Future -
inheritedExecutes
action
on each data event of the stream. -
handleError(
Function onError, {bool test(error)}) → Stream<List<int>> -
inheritedCreates a wrapper Stream that intercepts some errors from this stream.
-
join(
[String separator = ""]) → Future<String> -
inheritedCollects string of data events' string representations.
-
lastWhere(
bool test(T element), {Object defaultValue()}) → Future -
inheritedFinds the last element in this stream matching
test
. -
listen(
void onData(T event), {Function onError, void onDone(), bool cancelOnError}) → StreamSubscription<List<int>> -
inheritedAdds a subscription to this stream.
-
map(
dynamic convert(T event)) → Stream -
inheritedCreates a new stream that converts each element of this stream to a new value using the
convert
function. -
pipe(
StreamConsumer<List<int>> streamConsumer) → Future -
inheritedPipe the events of this stream into
streamConsumer
. -
reduce(
T combine(T previous, T element)) → Future<List<int>> -
inheritedReduces a sequence of values by repeatedly applying
combine
. -
renegotiate(
{bool useSessionCache: true, bool requestClientCertificate: false, bool requireClientCertificate: false}) → void - Renegotiate an existing secure connection, renewing the session keys and possibly changing the connection properties.
-
setOption(
SocketOption option, bool enabled) → bool -
inheritedUse setOption to customize the RawSocket. See SocketOption for available options.
-
singleWhere(
bool test(T element)) → Future<List<int>> -
inheritedFinds the single element in this stream matching
test
. -
skip(
int count) → Stream<List<int>> -
inheritedSkips the first
count
data events from this stream. -
skipWhile(
bool test(T element)) → Stream<List<int>> -
inheritedSkip data events from this stream while they are matched by
test
. -
take(
int count) → Stream<List<int>> -
inheritedProvides at most the first
n
values of this stream. -
takeWhile(
bool test(T element)) → Stream<List<int>> -
inheritedForwards data events while
test
is successful. -
timeout(
Duration timeLimit, {void onTimeout(EventSink sink)}) → Stream -
inheritedCreates a new stream with the same events as this stream.
-
toList(
) → Future<List<List<int>>> -
inheritedCollects the data of this stream in a List.
-
toSet(
) → Future<Set<List<int>>> -
inheritedCollects the data of this stream in a Set.
-
transform(
StreamTransformer<List<int>> streamTransformer) → Stream -
inheritedChains this stream as the input of the provided StreamTransformer.
-
where(
bool test(T event)) → Stream<List<int>> -
inheritedCreates a new stream from this stream that discards some data events.
-
write(
Object obj) → void -
inheritedConverts
obj
to a String by invoking Object.toString and adds the encoding of the result to the target consumer. -
writeAll(
Iterable objects, [String separator = ""]) → void -
inheritedIterates over the given
objects
and writes them in sequence. -
writeCharCode(
int charCode) → void -
inheritedWrites the
charCode
tothis
. -
writeln(
[Object obj = ""]) → void -
inheritedConverts
obj
to a String by invoking Object.toString and writes the result tothis
, followed by a newline.