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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class OpenSSL::SSL::SSLServer - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Object
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="SocketForwarder.html">OpenSSL::SSL::SocketForwarder</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-accept">#accept</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-listen">#listen</a>
<li ><a href="#method-i-shutdown">#shutdown</a>
<li ><a href="#method-i-to_io">#to_io</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-OpenSSL::SSL::SSLServer">
<h1 id="class-OpenSSL::SSL::SSLServer" class="class">
class OpenSSL::SSL::SSLServer
</h1>
<section class="description">
<p><a href="SSLServer.html"><code>SSLServer</code></a> represents a TCP/IP server socket with Secure Sockets Layer.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-start_immediately" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">start_immediately</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>When true then <a href="SSLServer.html#method-i-accept"><code>accept</code></a> works exactly the same as TCPServer#accept</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(svr, ctx)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new instance of <a href="SSLServer.html"><code>SSLServer</code></a>.</p>
<ul><li>
<p><em>srv</em> is an instance of TCPServer.</p>
</li><li>
<p><em>ctx</em> is an instance of <a href="SSLContext.html"><code>OpenSSL::SSL::SSLContext</code></a>.</p>
</li></ul>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 488</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">svr</span>, <span class="ruby-identifier">ctx</span>)
<span class="ruby-ivar">@svr</span> = <span class="ruby-identifier">svr</span>
<span class="ruby-ivar">@ctx</span> = <span class="ruby-identifier">ctx</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">ctx</span>.<span class="ruby-identifier">session_id_context</span>
<span class="ruby-comment"># see #6137 - session id may not exceed 32 bytes</span>
<span class="ruby-identifier">prng</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Random</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">$0</span>.<span class="ruby-identifier">hash</span>)
<span class="ruby-identifier">session_id</span> = <span class="ruby-identifier">prng</span>.<span class="ruby-identifier">bytes</span>(<span class="ruby-value">16</span>).<span class="ruby-identifier">unpack</span>(<span class="ruby-string">'H*'</span>)[<span class="ruby-value">0</span>]
<span class="ruby-ivar">@ctx</span>.<span class="ruby-identifier">session_id_context</span> = <span class="ruby-identifier">session_id</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@start_immediately</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-accept" class="method-detail ">
<div class="method-heading">
<span class="method-name">accept</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Works similar to TCPServer#accept.</p>
<div class="method-source-code" id="accept-source">
<pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 516</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">accept</span>
<span class="ruby-comment"># Socket#accept returns [socket, addrinfo].</span>
<span class="ruby-comment"># TCPServer#accept returns a socket.</span>
<span class="ruby-comment"># The following comma strips addrinfo.</span>
<span class="ruby-identifier">sock</span>, = <span class="ruby-ivar">@svr</span>.<span class="ruby-identifier">accept</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">ssl</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLSocket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">sock</span>, <span class="ruby-ivar">@ctx</span>)
<span class="ruby-identifier">ssl</span>.<span class="ruby-identifier">sync_close</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">ssl</span>.<span class="ruby-identifier">accept</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@start_immediately</span>
<span class="ruby-identifier">ssl</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ssl</span>
<span class="ruby-identifier">ssl</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">sock</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">ex</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See IO#close for details.</p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 537</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-ivar">@svr</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-listen" class="method-detail ">
<div class="method-heading">
<span class="method-name">listen</span><span
class="method-args">(backlog=Socket::SOMAXCONN)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See TCPServer#listen for details.</p>
<div class="method-source-code" id="listen-source">
<pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 506</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">listen</span>(<span class="ruby-identifier">backlog</span>=<span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SOMAXCONN</span>)
<span class="ruby-ivar">@svr</span>.<span class="ruby-identifier">listen</span>(<span class="ruby-identifier">backlog</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-shutdown" class="method-detail ">
<div class="method-heading">
<span class="method-name">shutdown</span><span
class="method-args">(how=Socket::SHUT_RDWR)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See BasicSocket#shutdown for details.</p>
<div class="method-source-code" id="shutdown-source">
<pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 511</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">shutdown</span>(<span class="ruby-identifier">how</span>=<span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SHUT_RDWR</span>)
<span class="ruby-ivar">@svr</span>.<span class="ruby-identifier">shutdown</span>(<span class="ruby-identifier">how</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_io" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_io</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the TCPServer passed to the <a href="SSLServer.html"><code>SSLServer</code></a> when initialized.</p>
<div class="method-source-code" id="to_io-source">
<pre><span class="ruby-comment"># File lib/openssl/ssl.rb, line 501</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_io</span>
<span class="ruby-ivar">@svr</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
