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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
|
$Id$
'OpenSSL for Ruby' project
Copyright (C) 2001,2002 'OpenSSL for Ruby' team
All rights reserved.
This program is licenced under the same licence as Ruby.
(See the file 'LICENCE'.)
[Team members]
GOTOU Yuuzou <gotoyuzo@notwork.org> - SSL Socket implementation
Michal Rokos <m.rokos@sh.cvut.cz> - The rest (too long to enumerate)
[Contributors]
UNKNOWN <oss-ruby@technorama.net>oss-ruby@technorama.net - BN implementation core
Hynek Rostinsky <Hynek.Rostinsky@foresta.cz> - Windows platform fixes (strptime mainly)
[Done] (but not fully tested)
= PKey:: RSA,DSA keys - new, load, export
= X509::Certificate - generating new certs, load, looking inside
= X509::CRL - load, new, looking inside
= X509::Name - new, export to_str, to_a, to_h (hash)
= X509::Revoked - new, looking inside (on parameters)
= X509::Store - new, import trusted certs and CRL, verifiing certs
= Digest::... - various hashes
= X509::Request - Cert requests
= X509::Attribute - as X509Request extensions (not tested)
= X509::Extension - to Certs, CRLs...
= X509::ExtensionMaker - for easy creating new Extensions
= Netscape::SPKI - for requests from NetscapeCommunicators
= Cipher::... - various ciphers
= basic PRNG functions (random generator) for OpenSSL module and class Random
= SSLSocket (merged Gotou Yuuzou's SSLsocket-Ruby project)
= PKCS7 (signing&data_verify is working, rest needs some testing)
= HMAC
= OpenSSL config file parser (part)
= BN (safe bignums)
[To-Do]
= check for memory leaking :-))
= cleaner code
= examples
= RubyUnit to be used!
= API documentation
= comments to sources!!!
= further functionality to existing
= Std. Extensions, Attributes to be made as Classes?
= AttributeFactory?
= add aliases to to_pem as s_dump s_load to support Marshal module
= CipherFactory?
= autogen random IVs for Ciphers
= PKCS12
= PKCS8
= ASN.1 ???
= BIO ???
= compat tests for RSA/DSA sign/encrypt
[Requirements]
Ruby >= 1.6.4
OpenSSL >= 0.9.6b
[Instalation]
= Unix like systems:
ruby extconf.rb
make
su root -c make install
= Windows like systems:
add to %PATH%: c:\openssl\bin (where the dlls lays)
ruby extconf.rb --with-openssl-include=c:\openssl\include --with-openssl-lib=c:\openssl\lib
(or ruby extconf.rb --with-openssl-dir=c:\openssl (NOT TESTED))
nmake
nmake install
[Documentation/API]
Sorry, not done. See 'test' folder's examples and grep C sources for rb_define_*method :-))
--------------------------------------------------
-> XXX - XXX is return value
A <=> B - A is an alias to B
[XXX] - argument XXX is optional
A|B - argument can be A or B
bXXX - XXX is true or false
cXXX - XXX is defined as constant
fXXX - XXX is Fixnum
hXXX - XXX is Hash
nXXX - XXX is Number (Fixnum or Bignum)
oXXX - argument.kind_of?(XXX) -> true
sXXX - XXX is String
tXXX - XXX is instance of Time
--------------------------------------------------
Integer
.to_bn() -> BN.new
OpenSSL::
.seed(sSeed) -> sSeed
.load_random_file(sFilename) -> bResult
.write_random_file(sFilename) -> bResult
BN - Doc TODO!
BNError
Cipher::
constants: UNSPEC
modes: ECB, CFB, OFB, CBC
types: EDE, EDE3, BIT40, BIT64
BlowFish (allowed: ECB, CFB, OFB, CBC)
Cast5 (ECB, CFB, OFB, CBC)
DES (ECB, EDE, EDE3, CFB, CFB:EDE, CFB:EDE3, OFB, OFB:EDE, OFB:EDE3, CBC, CBC:EDE, CBC:EDE3)
Idea (ECB, CFB, OFB, CBC)
RC2 (ECB, CBC, BIT40:CBC, BIT64:CBC, CFB, OFB)
RC4 (nil, UNSPEC, BIT40)
RC5 (ECB, CFB, OFB, CBC)
.new([cMode|cType] [,cType|cMode])
----------------------------------
.encrypt(sPassword [, sInitVector]) -> self
.decrypt(sPassword [, sInitVector]) -> self
.update(sData) -> s(En|De)crypted
.<< <=> .update
.cipher() -> s(En|De)cryptedFinal
CipherError
Config
.new(sFilename) - dispatches .load
.load(sFilename)
----------------------------------
.get_value(sSection|nil, sKey) -> sValue
.get_section(sSection) -> hSection
ConfigError
Digest::
MD2
MD4
MD5
MDC2
RIPEMD160
SHA
SHA1
DSS
DSS1
.new([sData])
----------------------------------
.update(sData) -> self
.<< <=> .update
.digest() -> sDigestFinal
.hexdigest() -> sHEXDigestFinal
.inspect <=> .hexdigest
.to_str <=> .hexdigest
DigestError
HMAC
.new(sKey, oDigest::ANY) -> self
----------------------------------
.update(sData) -> self
.<< <=> .update
.hmac() -> sHMACFinal
.hexhmac() -> sHEXHMACFinal
.inspect <=> .hexhmac
.to_str <=> .hexhmac
HMACError
Netscape::
SPKI
.new([sPEM])
----------------------------------
.to_pem() -> sPEM
.to_str() -> sHumanReadable
.public_key() -> oPKey::ANY
.public_key=(oPKey::ANY) -> oPKey::ANY
.sign(oPKey::ANY, oDigest::ANY) -> self
.verify(oPKey::ANY) -> bResult
.challenge() -> sChallenge
.challenge=(sChallenge) -> sChallenge
SPKIError
PKCS7::
constants:
type: SIGNED, ENVELOPED, SIGNED_ENVELOPED
PKCS7
.new(cType|sPEM)
----------------------------------
.cipher=(oCipher::ANY) -> oCipher::ANY
.add_signer(oPKCS7::Signer, oPKey::ANY) -> self
.signers() -> Array of PKCS7::Signer
.add_recipient(oX509::Certificate) -> self
.add_certificate(oX509::Certificate) -> self
.add_crl(oX509::CRL) -> self
.add_data(sData [, bDetached]) -> self
.verify_data(oX509::Store [, sDetachedData]) -> bResult, yields PKCS7::Signer
.decode_data(oPKey::ANY, oX509::Certificate) -> sData
.to_pem() -> sPEM
Signer
.new(oX509::Certificate, oPKey::ANY, oDigest::ANY)
----------------------------------
.name() -> X509::Name
.serial() -> fSerial
.signed_time() -> tTime
PKCS7Error
PKey::
PKeyError
DSA
.new([fKeyLen|sPEM [, sPassword]]) - dispatches .new_from_pem or .generate
.new_from_pem(sPEM [, sPassword])
.generate(fKeyLen) - yields |p,n|
.new_from_fixnum <=> generate
----------------------------------
.public?() -> bResult
.private?() -> bResult
.to_str() -> sHumanReadable
.export([oCipher::ANY [, sPassword]]) -> sPEM
.to_pem <=> .export
.public_key() -> oPKey::ANY
.to_der() -> sDER
.sign(oDigest::ANY, sData) -> sSig
.sign_digest(sDigest) -> sSig
.verify(oDigest::ANY, sData, sSig) -> bResult
.verify_digest(sDigest, sSig) -> bResult
DSAError
RSA
.new([fKeyLen|sPEM [, sPassword]]) - dispatches .new_from_pem or .generate
.new_from_pem(sPEM [, sPassword])
.generate(fKeyLen) - yields |p,n|
.new_from_fixnum <=> generate
----------------------------------
.public?() -> bResult
.private?() -> bResult
.to_str() -> sHumanReadable
.export([oCipher::ANY [, sPassword]]) -> sPEM
.to_pem <=> .export
.public_key() -> oPKey::ANY
.public_encrypt(sData) -> sEnc
.public_decrypt(sEnrypted) -> sData
.private_encrypt(sData) -> sEnc
.private_decrypt(sEncrypted) -> sData
.to_der() -> sDER
.sign(oDigest::ANY, sData) -> sSig
.verify(oDigest::ANY, sData, sSig) -> bResult
RSAError
Random
.new is default
----------------------------------
.seed(sSeed) -> sSeed
.load_random_file(sFilename) -> bResult
.write_random_file(sFilename) -> bResult
.random_bytes(fLen) -> sRandom
RandomError
SSL:: - Doc TODO!
Error
X509::
Attribute
.new(arg) - dispatches "new_from_#{arg.type.name.downcase}"
.new_from_string("oid = value")
.new_from_array(["oid", "value"])
.new_from_hash({"oid"=>"oid", "value"=>"val"})
----------------------------------
AttributeError
Certificate - Doc TODO!
CertificateError
CRL - Doc TODO!
CRLError
Extension - Doc TODO!
.new is DISABLED!
----------------------------------
.to_str -> string as "oid = critical, value"
.to_a -> ary as ["oid", "value", critical], critical as bool
.to_h -> hash as {"oid"=>"oid", "value"=>"val", "critical"=>bool}
ExtensionFactory - Doc TODO!
.new(...)
----------------------------------
.create_extension(*arg)
.create_ext_from_string(str)
.create_ext_from_ary(ary) -> X509::Extension, ary as ["oid", "value", critical], critical as bool
.create_ext_from_hash(hash)
ExtensionError
Name - Doc TODO!
.new(arg) dispatches "new_from_#{arg.type.name.downcase}"
.new_from_string(str) -> self, str as "/A=B/C=D/E=F"
.new_from_array(ary) -> self, ary as [["A","B"],["C","D"],["E","F"]]
.new_from_hash(hash) -> self, hash as {"A"=>"B","C"=>"D","E"=>"F"}
----------------------------------
.to_str -> str as "/A=B/C=D/E=F"
.to_a -> ary as [["A","B"],["C","D"],["E","F"]]
.to_h -> hash as {"A"=>"B","C"=>"D","E"=>"F"}
NameError
Request - Doc TODO!
RequestError
Revoked - Doc TODO!
RevokedError
Store - Doc TODO!
StoreError
--------------------------------------------------
[Examples]
There are some braindead in 'test' directory
[Note]
All code is under development - API/method names can change
All feedback, bug reports, requests are welcomed!
Enjoy!
Michal <m.rokos@sh.cvut.cz>
|