class OpenSSL::SSL::Server
Overview
This class wraps another ::Socket::Server in an SSL layer.
require "socket"
require "openssl"
tcp_server = TCPServer.new(0)
ssl_context = OpenSSL::SSL::Context::Server.new
ssl_context.certificate_chain = "openssl.crt"
ssl_context.private_key = "openssl.key"
ssl_server = OpenSSL::SSL::Server.new(tcp_server, ssl_context)
puts "SSL Server listening on #{tcp_server.local_address}"
while connection = ssl_server.accept?
connection.puts "secure message"
connection.close
end Included Modules
Defined in:
openssl/ssl/server.crConstructors
- .new(wrapped : ::Socket::Server, context : OpenSSL::SSL::Context::Server = OpenSSL::SSL::Context::Server.new, sync_close : Bool = true)
Creates a new SSL server wrapping wrapped.
Class Method Summary
- .open(wrapped : ::Socket::Server, context : OpenSSL::SSL::Context::Server = OpenSSL::SSL::Context::Server.new, sync_close : Bool = true, &)
Creates a new SSL server wrapping wrapped and yields it to the block.
Instance Method Summary
- #accept : OpenSSL::SSL::Socket::Server
Implements
::Socket::Server#accept. - #accept? : OpenSSL::SSL::Socket::Server?
Implements
::Socket::Server#accept?. - #close : Nil
Closes this SSL server.
- #closed? : Bool
Returns
trueif this SSL server has been closed. - #context : OpenSSL::SSL::Context::Server
Returns the SSL context.
- #local_address : ::Socket::Address
Returns local address of
#wrapped. - #start_immediately : Bool
When
truea call to#acceptwill also initiate the SSL handshake. - #start_immediately=(start_immediately : Bool)
When
truea call to#acceptwill also initiate the SSL handshake. - #sync_close=(sync_close : Bool)
If
#sync_close?istrue, closing this server will close the wrapped server. - #sync_close? : Bool
If
#sync_close?istrue, closing this server will close the wrapped server. - #wrapped : ::Socket::Server
Returns the wrapped server socket.
Instance methods inherited from module Socket::Server
accept : IOaccept(&) accept, accept? : IO?
accept?(&) accept?
Instance methods inherited from class Reference
==(other : self)==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference) : Bool
same?(other : Nil) same?, to_s(io : IO) : Nil to_s
Constructor methods inherited from class Reference
new new Instance methods inherited from class Object
! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash(hasher)
hash hash, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?, inspect(io : IO) : Nil
inspect : String inspect, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO) : Nil
to_json : String to_json, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json, to_s(io : IO) : Nil
to_s : String to_s, to_yaml(io : IO) : Nil
to_yaml : String to_yaml, try(&) try, unsafe_as(type : T.class) forall T unsafe_as
Class methods inherited from class Object
from_json(string_or_io, root : String)from_json(string_or_io) from_json, from_yaml(string_or_io : String | IO) from_yaml
Constructor Detail
def self.new(wrapped : ::Socket::Server, context : OpenSSL::SSL::Context::Server = OpenSSL::SSL::Context::Server.new, sync_close : Bool = true)Source
Creates a new SSL server wrapping wrapped.
context configures the SSL options, see OpenSSL::SSL::Context::Server for details
Class Method Detail
def self.open(wrapped : ::Socket::Server, context : OpenSSL::SSL::Context::Server = OpenSSL::SSL::Context::Server.new, sync_close : Bool = true, &)Source
Creates a new SSL server wrapping wrapped and yields it to the block.
context configures the SSL options, see OpenSSL::SSL::Context::Server for details
The server is closed after the block returns.
Instance Method Detail
def accept : OpenSSL::SSL::Socket::ServerSource
Implements ::Socket::Server#accept.
This method calls @wrapped.accept and wraps the resulting IO in a SSL socket (OpenSSL::SSL::Socket::Server) with #context configuration.
def accept? : OpenSSL::SSL::Socket::Server?Source
Implements ::Socket::Server#accept?.
This method calls @wrapped.accept? and wraps the resulting IO in a SSL socket (OpenSSL::SSL::Socket::Server) with #context configuration.
def context : OpenSSL::SSL::Context::ServerSource
Returns the SSL context.
def local_address : ::Socket::AddressSource
Returns local address of #wrapped.
def start_immediately : BoolSource
When true a call to #accept will also initiate the SSL handshake.
def start_immediately=(start_immediately : Bool)Source
When true a call to #accept will also initiate the SSL handshake.
def sync_close=(sync_close : Bool)Source
If #sync_close? is true, closing this server will close the wrapped server.
def sync_close? : BoolSource
If #sync_close? is true, closing this server will close the wrapped server.
def wrapped : ::Socket::ServerSource
Returns the wrapped server socket.
© 2012–2021 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/1.2.1/OpenSSL/SSL/Server.html