-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathSecureRandom.html
184 lines (97 loc) · 4.88 KB
/
SecureRandom.html
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
---
title: SecureRandom
layout: default
---
<div class="main">
<div class="banner">
<span>Ruby on Rails 8.0.0</span><br />
<div class="type">Module</div>
<h1>
SecureRandom
</h1>
<ul class="files">
<li><a href="../files/activesupport/lib/active_support/core_ext/securerandom_rb.html">activesupport/lib/active_support/core_ext/securerandom.rb</a></li>
</ul>
</div>
<div id="bodyContent">
<div id="content">
<h2 id="methods">Methods</h2>
<ul>
<li>
<a href="#method-c-base36">base36</a>
</li>
<li>
<a href="#method-c-base58">base58</a>
</li>
</ul>
<!-- Section constants -->
<h2 id="constants">Constants</h2>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class="attr-name">BASE36_ALPHABET</td>
<td>=</td>
<td class="attr-value">("0".."9").to_a + ("a".."z").to_a</td>
</tr>
<tr valign='top'>
<td class="attr-name">BASE58_ALPHABET</td>
<td>=</td>
<td class="attr-value">("0".."9").to_a + ("A".."Z").to_a + ("a".."z").to_a - ["0", "O", "I", "l"]</td>
</tr>
</table>
<!-- Methods -->
<h2 id="class-public-methods">Class Public methods</h2>
<div class="method">
<h3 id="method-c-base36">
base36(n = 16)
</h3>
<div class="description">
<p><a href="SecureRandom.html#method-c-base36"><code>SecureRandom.base36</code></a> generates a random base36 string in lowercase.</p>
<p>The argument <em>n</em> specifies the length of the random string to be generated.</p>
<p>If <em>n</em> is not specified or is <code>nil</code>, 16 is assumed. It may be larger in the future. This method can be used over <code>base58</code> if a deterministic case key is necessary.</p>
<p>The result will contain alphanumeric characters in lowercase.</p>
<pre><code>p SecureRandom.base36 # => "4kugl2pdqmscqtje"
p SecureRandom.base36(24) # => "77tmhrhjfvfdwodq8w7ev2m7"
</code></pre>
</div>
<details class="method__source">
<summary>
<span class="label">📝 Source code</span>
</summary>
<pre><code class="ruby"># File activesupport/lib/active_support/core_ext/securerandom.rb, line 34
def self.base36(n = 16)
SecureRandom.random_bytes(n).unpack("C*").map do |byte|
idx = byte % 64
idx = SecureRandom.random_number(36) if idx >= 36
BASE36_ALPHABET[idx]
end.join
end</code></pre>
<a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/activesupport/lib/active_support/core_ext/securerandom.rb#L34" target="_blank" class="github_url">🔎 See on GitHub</a>
</details>
</div>
<div class="method">
<h3 id="method-c-base58">
base58(n = 16)
</h3>
<div class="description">
<p><a href="SecureRandom.html#method-c-base58"><code>SecureRandom.base58</code></a> generates a random base58 string.</p>
<p>The argument <em>n</em> specifies the length of the random string to be generated.</p>
<p>If <em>n</em> is not specified or is <code>nil</code>, 16 is assumed. It may be larger in the future.</p>
<p>The result may contain alphanumeric characters except 0, O, I, and l.</p>
<pre><code>p SecureRandom.base58 # => "4kUgL2pdQMSCQtjE"
p SecureRandom.base58(24) # => "77TMHrHJFvFDwodq8w7Ev2m7"
</code></pre>
</div>
<details class="method__source">
<summary>
<span class="label">📝 Source code</span>
</summary>
<pre><code class="ruby"># File activesupport/lib/active_support/core_ext/securerandom.rb, line 19
def self.base58(n = 16)
SecureRandom.alphanumeric(n, chars: BASE58_ALPHABET)
end</code></pre>
<a href="https://github.com/rails/rails/blob/dd8f7185faeca6ee968a6e9367f6d8601a83b8db/activesupport/lib/active_support/core_ext/securerandom.rb#L19" target="_blank" class="github_url">🔎 See on GitHub</a>
</details>
</div>
</div>
</div>
</div>