signet 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG +3 -0
- data/LICENSE +202 -0
- data/README +47 -0
- data/Rakefile +59 -0
- data/lib/compat/digest/hmac.rb +104 -0
- data/lib/compat/securerandom.rb +202 -0
- data/lib/signet.rb +18 -0
- data/lib/signet/errors.rb +38 -0
- data/lib/signet/oauth_1.rb +456 -0
- data/lib/signet/oauth_1/client.rb +1012 -0
- data/lib/signet/oauth_1/credential.rb +119 -0
- data/lib/signet/oauth_1/signature_methods/hmac_sha1.rb +31 -0
- data/lib/signet/version.rb +26 -0
- data/spec/force_compat/digest/hmac.rb +1 -0
- data/spec/force_compat/securerandom.rb +1 -0
- data/spec/signet/oauth_1/client_spec.rb +687 -0
- data/spec/signet/oauth_1/credential_spec.rb +163 -0
- data/spec/signet/oauth_1/services/google_spec.rb +234 -0
- data/spec/signet/oauth_1/signature_methods/hmac_sha1_spec.rb +62 -0
- data/spec/signet/oauth_1_spec.rb +883 -0
- data/spec/spec.opts +2 -0
- data/spec/spec_helper.rb +10 -0
- data/tasks/clobber.rake +2 -0
- data/tasks/gem.rake +71 -0
- data/tasks/git.rake +40 -0
- data/tasks/metrics.rake +41 -0
- data/tasks/rdoc.rake +26 -0
- data/tasks/rubyforge.rake +100 -0
- data/tasks/spec.rake +69 -0
- data/tasks/yard.rake +26 -0
- data/website/index.html +95 -0
- metadata +195 -0
data/CHANGELOG
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
== Signet
|
2
|
+
|
3
|
+
Homepage:: signet.rubyforge.org[http://signet.rubyforge.org/]
|
4
|
+
Author:: Bob Aman (mailto:bobaman@google.com)
|
5
|
+
Copyright:: Copyright © 2010 Google Inc.
|
6
|
+
License:: Apache 2.0
|
7
|
+
|
8
|
+
== Description
|
9
|
+
|
10
|
+
Signet is an OAuth 1.0 / OAuth 2.0 implementation.
|
11
|
+
|
12
|
+
== Reference
|
13
|
+
|
14
|
+
- {Signet::OAuth1}
|
15
|
+
- {Signet::OAuth1::Client}
|
16
|
+
- {Signet::OAuth1::Credential}
|
17
|
+
|
18
|
+
== Example Usage for Google
|
19
|
+
|
20
|
+
require 'signet/oauth_1/client'
|
21
|
+
client = Signet::OAuth1::Client.new(
|
22
|
+
:temporary_credential_uri =>
|
23
|
+
'https://www.google.com/accounts/OAuthGetRequestToken',
|
24
|
+
:authorization_uri =>
|
25
|
+
'https://www.google.com/accounts/OAuthAuthorizeToken',
|
26
|
+
:token_credential_uri =>
|
27
|
+
'https://www.google.com/accounts/OAuthGetAccessToken',
|
28
|
+
:client_credential_key => 'anonymous',
|
29
|
+
:client_credential_secret => 'anonymous'
|
30
|
+
)
|
31
|
+
client.fetch_temporary_credential!(:additional_parameters => {
|
32
|
+
:scope => 'https://mail.google.com/mail/feed/atom'
|
33
|
+
})
|
34
|
+
# Send the user to client.authorization_uri, obtain verifier
|
35
|
+
client.fetch_token_credential!(:verifier => '12345')
|
36
|
+
response = client.fetch_protected_resource(
|
37
|
+
:uri => 'https://mail.google.com/mail/feed/atom'
|
38
|
+
)
|
39
|
+
status, headers, body = response
|
40
|
+
|
41
|
+
== Example Usage for Twitter
|
42
|
+
|
43
|
+
# Example usage goes here
|
44
|
+
|
45
|
+
== Install
|
46
|
+
|
47
|
+
* sudo gem install signet
|
data/Rakefile
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
lib_dir = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
|
2
|
+
$:.unshift(lib_dir)
|
3
|
+
$:.uniq!
|
4
|
+
|
5
|
+
require 'rubygems'
|
6
|
+
require 'rake'
|
7
|
+
require 'rake/testtask'
|
8
|
+
require 'rake/rdoctask'
|
9
|
+
require 'rake/packagetask'
|
10
|
+
require 'rake/gempackagetask'
|
11
|
+
require 'rake/contrib/rubyforgepublisher'
|
12
|
+
|
13
|
+
begin
|
14
|
+
require 'spec/rake/spectask'
|
15
|
+
rescue LoadError
|
16
|
+
STDERR.puts "Please install rspec:"
|
17
|
+
STDERR.puts "sudo gem install rspec"
|
18
|
+
exit(1)
|
19
|
+
end
|
20
|
+
|
21
|
+
require File.join(File.dirname(__FILE__), 'lib/signet', 'version')
|
22
|
+
|
23
|
+
PKG_DISPLAY_NAME = 'Signet'
|
24
|
+
PKG_NAME = PKG_DISPLAY_NAME.downcase
|
25
|
+
PKG_VERSION = Signet::VERSION::STRING
|
26
|
+
PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
|
27
|
+
|
28
|
+
RELEASE_NAME = "REL #{PKG_VERSION}"
|
29
|
+
|
30
|
+
RUBY_FORGE_PROJECT = PKG_NAME
|
31
|
+
RUBY_FORGE_USER = "sporkmonger"
|
32
|
+
RUBY_FORGE_PATH = "/var/www/gforge-projects/#{RUBY_FORGE_PROJECT}"
|
33
|
+
RUBY_FORGE_URL = "http://#{RUBY_FORGE_PROJECT}.rubyforge.org/"
|
34
|
+
|
35
|
+
PKG_AUTHOR = "Bob Aman"
|
36
|
+
PKG_AUTHOR_EMAIL = "bobaman@google.com"
|
37
|
+
PKG_HOMEPAGE = RUBY_FORGE_URL
|
38
|
+
PKG_SUMMARY = "Package Summary"
|
39
|
+
PKG_DESCRIPTION = <<-TEXT
|
40
|
+
Signet is an OAuth 1.0 / OAuth 2.0 implementation.
|
41
|
+
TEXT
|
42
|
+
|
43
|
+
PKG_FILES = FileList[
|
44
|
+
"lib/**/*", "spec/**/*", "vendor/**/*",
|
45
|
+
"tasks/**/*", "website/**/*",
|
46
|
+
"[A-Z]*", "Rakefile"
|
47
|
+
].exclude(/database\.yml/).exclude(/[_\.]git$/)
|
48
|
+
|
49
|
+
RCOV_ENABLED = (RUBY_PLATFORM != "java" && RUBY_VERSION =~ /^1\.8/)
|
50
|
+
if RCOV_ENABLED
|
51
|
+
task :default => "spec:verify"
|
52
|
+
else
|
53
|
+
task :default => "spec"
|
54
|
+
end
|
55
|
+
|
56
|
+
WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
|
57
|
+
SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
|
58
|
+
|
59
|
+
Dir['tasks/**/*.rake'].each { |rake| load rake }
|
@@ -0,0 +1,104 @@
|
|
1
|
+
# = digest/hmac.rb
|
2
|
+
#
|
3
|
+
# An implementation of HMAC keyed-hashing algorithm
|
4
|
+
#
|
5
|
+
# == Overview
|
6
|
+
#
|
7
|
+
# This library adds a method named hmac() to Digest classes, which
|
8
|
+
# creates a Digest class for calculating HMAC digests.
|
9
|
+
#
|
10
|
+
# == Examples
|
11
|
+
#
|
12
|
+
# require 'digest/hmac'
|
13
|
+
#
|
14
|
+
# # one-liner example
|
15
|
+
# puts Digest::HMAC.hexdigest("data", "hash key", Digest::SHA1)
|
16
|
+
#
|
17
|
+
# # rather longer one
|
18
|
+
# hmac = Digest::HMAC.new("foo", Digest::RMD160)
|
19
|
+
#
|
20
|
+
# buf = ""
|
21
|
+
# while stream.read(16384, buf)
|
22
|
+
# hmac.update(buf)
|
23
|
+
# end
|
24
|
+
#
|
25
|
+
# puts hmac.bubblebabble
|
26
|
+
#
|
27
|
+
# == License
|
28
|
+
#
|
29
|
+
# Copyright (c) 2006 Akinori MUSHA <knu@iDaemons.org>
|
30
|
+
#
|
31
|
+
# Documentation by Akinori MUSHA
|
32
|
+
#
|
33
|
+
# All rights reserved. You can redistribute and/or modify it under
|
34
|
+
# the same terms as Ruby.
|
35
|
+
#
|
36
|
+
# $Id: hmac.rb 14881 2008-01-04 07:26:14Z akr $
|
37
|
+
#
|
38
|
+
|
39
|
+
require 'digest'
|
40
|
+
|
41
|
+
unless defined?(Digest::HMAC)
|
42
|
+
module Digest
|
43
|
+
class HMAC < Digest::Class
|
44
|
+
def initialize(key, digester)
|
45
|
+
@md = digester.new
|
46
|
+
|
47
|
+
block_len = @md.block_length
|
48
|
+
|
49
|
+
if key.bytesize > block_len
|
50
|
+
key = @md.digest(key)
|
51
|
+
end
|
52
|
+
|
53
|
+
ipad = Array.new(block_len).fill(0x36)
|
54
|
+
opad = Array.new(block_len).fill(0x5c)
|
55
|
+
|
56
|
+
key.bytes.each_with_index { |c, i|
|
57
|
+
ipad[i] ^= c
|
58
|
+
opad[i] ^= c
|
59
|
+
}
|
60
|
+
|
61
|
+
@key = key.freeze
|
62
|
+
@ipad = ipad.inject('') { |s, c| s << c.chr }.freeze
|
63
|
+
@opad = opad.inject('') { |s, c| s << c.chr }.freeze
|
64
|
+
@md.update(@ipad)
|
65
|
+
end
|
66
|
+
|
67
|
+
def initialize_copy(other)
|
68
|
+
@md = other.instance_eval { @md.clone }
|
69
|
+
end
|
70
|
+
|
71
|
+
def update(text)
|
72
|
+
@md.update(text)
|
73
|
+
self
|
74
|
+
end
|
75
|
+
alias << update
|
76
|
+
|
77
|
+
def reset
|
78
|
+
@md.reset
|
79
|
+
@md.update(@ipad)
|
80
|
+
self
|
81
|
+
end
|
82
|
+
|
83
|
+
def finish
|
84
|
+
d = @md.digest!
|
85
|
+
@md.update(@opad)
|
86
|
+
@md.update(d)
|
87
|
+
@md.digest!
|
88
|
+
end
|
89
|
+
private :finish
|
90
|
+
|
91
|
+
def digest_length
|
92
|
+
@md.digest_length
|
93
|
+
end
|
94
|
+
|
95
|
+
def block_length
|
96
|
+
@md.block_length
|
97
|
+
end
|
98
|
+
|
99
|
+
def inspect
|
100
|
+
sprintf('#<%s: key=%s, digest=%s>', self.class.name, @key.inspect, @md.inspect.sub(/^\#<(.*)>$/) { $1 });
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
104
|
+
end
|
@@ -0,0 +1,202 @@
|
|
1
|
+
# = Secure random number generator interface.
|
2
|
+
#
|
3
|
+
# This library is an interface for secure random number generator which is
|
4
|
+
# suitable for generating session key in HTTP cookies, etc.
|
5
|
+
#
|
6
|
+
# It supports following secure random number generators.
|
7
|
+
#
|
8
|
+
# * openssl
|
9
|
+
# * /dev/urandom
|
10
|
+
# * Win32
|
11
|
+
#
|
12
|
+
# == Example
|
13
|
+
#
|
14
|
+
# # random hexadecimal string.
|
15
|
+
# p SecureRandom.hex(10) #=> "52750b30ffbc7de3b362"
|
16
|
+
# p SecureRandom.hex(10) #=> "92b15d6c8dc4beb5f559"
|
17
|
+
# p SecureRandom.hex(11) #=> "6aca1b5c58e4863e6b81b8"
|
18
|
+
# p SecureRandom.hex(12) #=> "94b2fff3e7fd9b9c391a2306"
|
19
|
+
# p SecureRandom.hex(13) #=> "39b290146bea6ce975c37cfc23"
|
20
|
+
# ...
|
21
|
+
#
|
22
|
+
# # random base64 string.
|
23
|
+
# p SecureRandom.base64(10) #=> "EcmTPZwWRAozdA=="
|
24
|
+
# p SecureRandom.base64(10) #=> "9b0nsevdwNuM/w=="
|
25
|
+
# p SecureRandom.base64(10) #=> "KO1nIU+p9DKxGg=="
|
26
|
+
# p SecureRandom.base64(11) #=> "l7XEiFja+8EKEtY="
|
27
|
+
# p SecureRandom.base64(12) #=> "7kJSM/MzBJI+75j8"
|
28
|
+
# p SecureRandom.base64(13) #=> "vKLJ0tXBHqQOuIcSIg=="
|
29
|
+
# ...
|
30
|
+
#
|
31
|
+
# # random binary string.
|
32
|
+
# p SecureRandom.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
|
33
|
+
# p SecureRandom.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
|
34
|
+
# ...
|
35
|
+
|
36
|
+
if !defined?(SecureRandom)
|
37
|
+
begin
|
38
|
+
require 'openssl'
|
39
|
+
rescue LoadError
|
40
|
+
end
|
41
|
+
|
42
|
+
module SecureRandom
|
43
|
+
# SecureRandom.random_bytes generates a random binary string.
|
44
|
+
#
|
45
|
+
# The argument n specifies the length of the result string.
|
46
|
+
#
|
47
|
+
# If n is not specified, 16 is assumed.
|
48
|
+
# It may be larger in future.
|
49
|
+
#
|
50
|
+
# If secure random number generator is not available,
|
51
|
+
# NotImplementedError is raised.
|
52
|
+
def self.random_bytes(n=nil)
|
53
|
+
n ||= 16
|
54
|
+
|
55
|
+
if defined? OpenSSL::Random
|
56
|
+
return OpenSSL::Random.random_bytes(n)
|
57
|
+
end
|
58
|
+
|
59
|
+
if !defined?(@has_urandom) || @has_urandom
|
60
|
+
flags = File::RDONLY
|
61
|
+
flags |= File::NONBLOCK if defined? File::NONBLOCK
|
62
|
+
flags |= File::NOCTTY if defined? File::NOCTTY
|
63
|
+
flags |= File::NOFOLLOW if defined? File::NOFOLLOW
|
64
|
+
begin
|
65
|
+
File.open("/dev/urandom", flags) {|f|
|
66
|
+
unless f.stat.chardev?
|
67
|
+
raise Errno::ENOENT
|
68
|
+
end
|
69
|
+
@has_urandom = true
|
70
|
+
ret = f.readpartial(n)
|
71
|
+
if ret.length != n
|
72
|
+
raise NotImplementedError,
|
73
|
+
"Unexpected partial read from random device"
|
74
|
+
end
|
75
|
+
return ret
|
76
|
+
}
|
77
|
+
rescue Errno::ENOENT
|
78
|
+
@has_urandom = false
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
if !defined?(@has_win32)
|
83
|
+
begin
|
84
|
+
require 'Win32API'
|
85
|
+
|
86
|
+
crypt_acquire_context = Win32API.new(
|
87
|
+
"advapi32", "CryptAcquireContext", 'PPPII', 'L'
|
88
|
+
)
|
89
|
+
@crypt_gen_random = Win32API.new(
|
90
|
+
"advapi32", "CryptGenRandom", 'LIP', 'L'
|
91
|
+
)
|
92
|
+
|
93
|
+
hProvStr = " " * 4
|
94
|
+
prov_rsa_full = 1
|
95
|
+
crypt_verifycontext = 0xF0000000
|
96
|
+
|
97
|
+
if crypt_acquire_context.call(
|
98
|
+
hProvStr, nil, nil, prov_rsa_full, crypt_verifycontext) == 0
|
99
|
+
raise SystemCallError,
|
100
|
+
"CryptAcquireContext failed: #{lastWin32ErrorMessage}"
|
101
|
+
end
|
102
|
+
@hProv, = hProvStr.unpack('L')
|
103
|
+
|
104
|
+
@has_win32 = true
|
105
|
+
rescue LoadError
|
106
|
+
@has_win32 = false
|
107
|
+
end
|
108
|
+
end
|
109
|
+
if @has_win32
|
110
|
+
bytes = " " * n
|
111
|
+
if @crypt_gen_random.call(@hProv, bytes.size, bytes) == 0
|
112
|
+
raise SystemCallError,
|
113
|
+
"CryptGenRandom failed: #{lastWin32ErrorMessage}"
|
114
|
+
end
|
115
|
+
return bytes
|
116
|
+
end
|
117
|
+
|
118
|
+
raise NotImplementedError, "No random device"
|
119
|
+
end
|
120
|
+
|
121
|
+
# SecureRandom.hex generates a random hex string.
|
122
|
+
#
|
123
|
+
# The argument n specifies the length of the random length.
|
124
|
+
# The length of the result string is twice of n.
|
125
|
+
#
|
126
|
+
# If n is not specified, 16 is assumed.
|
127
|
+
# It may be larger in future.
|
128
|
+
#
|
129
|
+
# If secure random number generator is not available,
|
130
|
+
# NotImplementedError is raised.
|
131
|
+
def self.hex(n=nil)
|
132
|
+
random_bytes(n).unpack("H*")[0]
|
133
|
+
end
|
134
|
+
|
135
|
+
# SecureRandom.base64 generates a random base64 string.
|
136
|
+
#
|
137
|
+
# The argument n specifies the length of the random length.
|
138
|
+
# The length of the result string is about 4/3 of n.
|
139
|
+
#
|
140
|
+
# If n is not specified, 16 is assumed.
|
141
|
+
# It may be larger in future.
|
142
|
+
#
|
143
|
+
# If secure random number generator is not available,
|
144
|
+
# NotImplementedError is raised.
|
145
|
+
def self.base64(n=nil)
|
146
|
+
[random_bytes(n)].pack("m*").delete("\n")
|
147
|
+
end
|
148
|
+
|
149
|
+
# SecureRandom.random_number generates a random number.
|
150
|
+
#
|
151
|
+
# If an positive integer is given as n,
|
152
|
+
# SecureRandom.random_number returns an integer:
|
153
|
+
# 0 <= SecureRandom.random_number(n) < n.
|
154
|
+
#
|
155
|
+
# If 0 is given or an argument is not given,
|
156
|
+
# SecureRandom.random_number returns an float:
|
157
|
+
# 0.0 <= SecureRandom.random_number() < 1.0.
|
158
|
+
def self.random_number(n=0)
|
159
|
+
if 0 < n
|
160
|
+
hex = n.to_s(16)
|
161
|
+
hex = '0' + hex if (hex.length & 1) == 1
|
162
|
+
bin = [hex].pack("H*")
|
163
|
+
first = bin[0..0]
|
164
|
+
mask = first.respond_to?(:ord) ? first.ord : first.sum(8)
|
165
|
+
mask |= mask >> 1
|
166
|
+
mask |= mask >> 2
|
167
|
+
mask |= mask >> 4
|
168
|
+
begin
|
169
|
+
rnd = SecureRandom.random_bytes(bin.length)
|
170
|
+
first = rnd[0..0]
|
171
|
+
ordinal = first.respond_to?(:ord) ? first.ord : first.sum(8)
|
172
|
+
rnd[0..0] = (ordinal & mask).chr
|
173
|
+
end until rnd < bin
|
174
|
+
rnd.unpack("H*")[0].hex
|
175
|
+
else
|
176
|
+
# assumption: Float::MANT_DIG <= 64
|
177
|
+
i64 = SecureRandom.random_bytes(8).unpack("Q")[0]
|
178
|
+
Math.ldexp(i64 >> (64-Float::MANT_DIG), -Float::MANT_DIG)
|
179
|
+
end
|
180
|
+
end
|
181
|
+
|
182
|
+
# Following code is based on David Garamond's GUID library for Ruby.
|
183
|
+
def self.lastWin32ErrorMessage # :nodoc:
|
184
|
+
get_last_error = Win32API.new(
|
185
|
+
"kernel32", "GetLastError", '', 'L'
|
186
|
+
)
|
187
|
+
format_message = Win32API.new(
|
188
|
+
"kernel32", "FormatMessageA", 'LPLLPLPPPPPPPP', 'L'
|
189
|
+
)
|
190
|
+
format_message_ignore_inserts = 0x00000200
|
191
|
+
format_message_from_system = 0x00001000
|
192
|
+
|
193
|
+
code = get_last_error.call
|
194
|
+
msg = "\0" * 1024
|
195
|
+
len = format_message.call(
|
196
|
+
format_message_ignore_inserts + format_message_from_system,
|
197
|
+
0, code, 0, msg, 1024, nil, nil, nil, nil, nil, nil, nil, nil
|
198
|
+
)
|
199
|
+
msg[0, len].tr("\r", '').chomp
|
200
|
+
end
|
201
|
+
end
|
202
|
+
end
|