public class TlsSessionContext <: Equatable<TlsSessionContext> & ToString
功能:该类表示 TLS 会话上下文,给客户端提供信息,确保客户端所连接的服务端仍为相同实例,用于连接复用时,验证客户端合法性。
当客户端尝试恢复会话时,双方都必须确保他们正在恢复与合法对端的会话。
public static func fromName(name: String): TlsSessionContext
功能:通过名称创建 TlsSessionContext 实例。
通过 TlsSessionContext 保存的名称获取 TlsSessionContext 对象。该名称用于区分 TLS 服务器,因此客户端依赖此名称来避免意外,尝试恢复与错误的服务器的连接。这里不一定使用加密安全名称,因为底层实现可以完成这项工作。从此函数返回的具有相同名称的两个 TlsSessionContext 可能不相等,并且不保证可替换。尽管它们是从相同的名称创建的,因此服务器实例应该在整个生命周期内创建一个 TlsSessionContext ,并且在每次 TlsSocket.server() 调用中使用它。
参数:
返回值:
public override func toString(): String
功能:生成会话上下文名称字符串。
返回值:
public override operator func !=(other: TlsSessionContext)
功能:判断两 TlsSessionContext 实例名称是否不同。
参数:
返回值:
public override operator func ==(other: TlsSessionContext)
功能:判断两 TlsSessionContext 实例名称是否相同。
参数:
返回值:
public class TlsSocket <: StreamingSocket & ToString & Equatable<TlsSocket> & Hashable
功能:TlsSocket 用于在客户端及服务端间创建加密传输通道。
public prop alpnProtocolName: ?String
功能:读取协商到的应用层协议名称。
类型:?String
异常:
public prop cipherSuite: CipherSuite
功能:握手后协商到的加密套。
密码套件包含加密算法、用于消息认证的散列函数、密钥交换算法。
类型:CipherSuite
异常:
public prop clientCertificate: ?Array<X509Certificate>
功能:客户端提供的客户端证书。在客户端获取时为本端证书,在服务端获取时为对端证书。
当客户端会话恢复时,它可能会丢失。
类型:?Array<X509Certificate>
异常:
public prop domain: ?String
功能:读取协商到的服务端主机名称。
类型:?String
public override prop localAddress: SocketAddress
功能:读取 TlsSocket 的本地地址。
异常:
public prop peerCertificate: ?Array<X509Certificate>
功能:对端证书(如果对端提供)。
在客户端获取时同 serverCertificate ,在服务端获取时同 clientCertificate。
类型:?Array<X509Certificate>
异常:
public override mut prop readTimeout: ?Duration
功能:读写 TlsSocket 的读超时时间。
类型:?Duration
异常:
public override prop remoteAddress: SocketAddress
功能:读取 TlsSocket 的远端地址。
异常:
public prop serverCertificate: Array<X509Certificate>
功能:服务器证书链由服务器提供或在服务器配置中预先配置。在服务端获取时为本端证书,在客户端获取时为对端证书。
当进行 TLS 握手时,如果不需要服务端发送证书,通过此方法无法获取服务端证书。
类型:Array<X509Certificate>
异常:
public prop session: ?TlsSession
功能:读取 TLS 会话 id , 客户端会在握手成功后捕获当前会话的 id ,可使用该 id 重用该会话,省去 TLS 建立连接时间。连接建立未成功时,返回 None。
服务端不做捕获因此始终为 None。
类型:?TlsSession
异常:
public prop socket: StreamingSocket
功能:TlsSocket 创建所使用的 StreamingSocket。
异常:
public prop tlsVersion: TlsVersion
功能:读取协商到的 TLS 版本。
类型:TlsVersion
异常:
public override mut prop writeTimeout: ?Duration
功能:读写 TlsSocket 的写超时时间。
类型:?Duration
异常:
public static func client(
socket: StreamingSocket,
session!: ?TlsSession = None,
clientConfig!: TlsClientConfig = TlsClientConfig()
): TlsSocket 功能:根据传入的 StreamingSocket 实例创建指定地址的客户端 TLS 套接字,该套接字可用于客户端 TLS 握手及会话。
参数:
返回值:
public static func server(
socket: StreamingSocket,
sessionContext!: ?TlsSessionContext = None,
serverConfig!: TlsServerConfig
): TlsSocket 功能:根据传入的 StreamingSocket 实例创建指定地址的服务端 TLS 套接字,该套接字可用于服务端 TLS 握手及会话。
参数:
返回值:
public func handshake(timeout!: ?Duration = None): Unit
功能:TLS 握手。不支持重新协商握手,因此只能被调用一次。调用对象可以为客户端或者服务端的 TlsSocket。
参数:
异常:
public override func hashCode(): Int64
功能:返回 TLS 套接字对象的哈希值。
返回值:
public func isClosed(): Bool
功能:返回套接字是否关闭的状态。
返回值:
public override func read(buffer: Array<Byte>): Int64
功能:TlsSocket 读取数据。
参数:
返回值:
异常:
public func toString(): String
功能:套接字的字符串表示,字符串内容为当前套接字状态。
返回值:
public func write(buffer: Array<Byte>): Unit
功能:TlsSocket 发送数据。
参数:
异常: