rubydkim 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
data/LICENSE ADDED
@@ -0,0 +1,339 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ <signature of Ty Coon>, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.
data/README ADDED
@@ -0,0 +1,4 @@
1
+ RubyDKIM - a ruby extension for creating & verifying DKIM signatures
2
+
3
+ This is a wrapper around the PDKIM project, courtesy of Tom Kistner:
4
+ http://duncanthrax.net/pdkim/
data/Rakefile ADDED
@@ -0,0 +1,84 @@
1
+ begin
2
+ require 'rake/gempackagetask'
3
+ rescue LoadError
4
+ puts "got error: #{$!}"
5
+ end
6
+ require 'rake/clean'
7
+ require 'rbconfig'
8
+ include Config
9
+
10
+ PKG_NAME = 'DKIM'
11
+ PKG_VERSION = File.read('VERSION').chomp
12
+ PKG_FILES = FileList["**/*"].exclude(/CVS|pkg|tmp|coverage|Makefile/).exclude(/\.(so|bundle|o|#{CONFIG['DLEXT']})$/)
13
+ EXT_ROOT_DIR = 'src/dkim'
14
+ EXT_SIGNER_DIR = "#{EXT_ROOT_DIR}/signer"
15
+ EXT_SIGNER_SRC = "#{EXT_SIGNER_DIR}/signer.c"
16
+ EXT_SIGNER_DL = "#{EXT_ROOT_DIR}/signer.#{CONFIG['DLEXT']}"
17
+ EXT_VERIFIER_DIR = "#{EXT_ROOT_DIR}/verifier"
18
+ EXT_VERIFIER_SRC = "#{EXT_VERIFIER_DIR}/verifier.c"
19
+ EXT_VERIFIER_DL = "#{EXT_ROOT_DIR}/verifier.#{CONFIG['DLEXT']}"
20
+ EXT_DEST_DIR = "lib"
21
+ CLEAN.include FileList["src/**/{Makefile,mkmf.log}"], FileList["pkg"],
22
+ FileList["{src,lib}/**/*.{so,bundle,#{CONFIG['DLEXT']},o,obj,pdb,lib,manifest,exp,def}"]
23
+
24
+ task :default => [ EXT_SIGNER_DL, EXT_VERIFIER_DL ]
25
+
26
+ desc "Compiling extension"
27
+ task :compile_ext => [ EXT_SIGNER_DL, EXT_VERIFIER_DL ]
28
+
29
+ file EXT_SIGNER_DL => EXT_SIGNER_SRC do
30
+ cd EXT_SIGNER_DIR do
31
+ ruby 'extconf.rb'
32
+ system 'make'
33
+ end
34
+ cp "#{EXT_SIGNER_DIR}/signer.#{CONFIG['DLEXT']}", EXT_DEST_DIR
35
+ end
36
+
37
+ file EXT_VERIFIER_DL => EXT_VERIFIER_SRC do
38
+ cd EXT_VERIFIER_DIR do
39
+ ruby 'extconf.rb'
40
+ system 'make'
41
+ end
42
+ cp "#{EXT_VERIFIER_DIR}/verifier.#{CONFIG['DLEXT']}", EXT_DEST_DIR
43
+ end
44
+
45
+ # creating the gems
46
+ if defined?(Gem) and defined?(Rake::GemPackageTask)
47
+
48
+ spec_ext = Gem::Specification.new do |s|
49
+ s.name = 'rubydkim'
50
+ s.version = PKG_VERSION
51
+ s.summary = "A gem for creating & verifying DKIM signatures"
52
+ s.description = "This is a DKIM implementation as a Ruby extension in C."
53
+ s.add_dependency('dnsruby')
54
+
55
+ s.files = PKG_FILES
56
+
57
+ s.extensions = FileList['src/**/extconf.rb']
58
+
59
+ s.require_paths << 'lib'
60
+
61
+ s.bindir = "bin"
62
+ s.executables = [ "dkim_sign.rb", "dkim_verify.rb" ]
63
+ s.default_executable = "dkim_verify.rb"
64
+
65
+ s.has_rdoc = false
66
+
67
+ s.author = "Ian Ragsdale"
68
+ s.email = "ian.ragsdale@gmail.com"
69
+ s.homepage = "http://github.com/iragsdale/rubydkim"
70
+ end
71
+
72
+ desc "Generate gemspec"
73
+ task :gemspec do
74
+ File.open("#{spec_ext.name}.gemspec", "w") do |file|
75
+ file.puts spec_ext.to_ruby
76
+ end
77
+ end
78
+
79
+ Rake::GemPackageTask.new(spec_ext) do |pkg|
80
+ pkg.need_tar = true
81
+ pkg.package_files = PKG_FILES
82
+ end
83
+
84
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.3.1
data/bin/dkim_sign.rb ADDED
@@ -0,0 +1,20 @@
1
+ #!/usr/bin/ruby
2
+ # Reads an email in from standard input and signs it
3
+ require "dkim"
4
+
5
+ domain, selector, keyfile = ARGV
6
+ key = File.readlines(keyfile).join
7
+
8
+ # read the email
9
+ signer = DKIM::Signer.new(domain, selector, key)
10
+ message = ""
11
+ STDIN.each_line do |line|
12
+ line.gsub!(/\n/, "\r\n")
13
+ signer.feed(line)
14
+ message << line
15
+ end
16
+
17
+ signature = signer.finish
18
+
19
+ # print out the signature then the email
20
+ puts "#{signature.signature_header}\n#{message}"
@@ -0,0 +1,23 @@
1
+ #!/usr/bin/ruby
2
+ # Reads an email in from standard input and tries to verify it
3
+ require "dkim"
4
+
5
+ # read the email
6
+ verifier = DKIM::Verifier.new
7
+ STDIN.each_line do |line|
8
+ verifier.feed(line)
9
+ end
10
+
11
+ # grab the list of signatures found
12
+ signatures = verifier.finish
13
+
14
+ # display the results
15
+ if signatures.empty?
16
+ puts "No signatures found!"
17
+ else
18
+ signatures.each do |signature|
19
+ dnsname = "#{signature.selector}._domainkey.#{signature.domain}"
20
+ puts "signature: #{dnsname} passed? #{signature.passed?}"
21
+ puts signature.inspect
22
+ end
23
+ end
data/lib/dkim.rb ADDED
@@ -0,0 +1,45 @@
1
+ # add our dir to the load path
2
+ $:.unshift File.dirname(__FILE__)
3
+ require 'signer'
4
+ require 'verifier'
5
+ # we do DNS lookups in dnsruby
6
+ require 'rubygems'
7
+ require 'dnsruby'
8
+
9
+ module DKIM
10
+ class Signature
11
+ attr_accessor :version, :algo, :canon_headers, :canon_body, :querymethod,
12
+ :selector, :domain, :identity, :created, :expires, :bodylength,
13
+ :headernames, :copiedheaders, :sigdata, :bodyhash, :signature_header,
14
+ :verify_status, :verify_ext_status, :pubkey
15
+
16
+ PDKIM_VERIFY_NONE = 0
17
+ PDKIM_VERIFY_INVALID = 1
18
+ PDKIM_VERIFY_FAIL = 2
19
+ PDKIM_VERIFY_PASS = 3
20
+
21
+ PDKIM_VERIFY_FAIL_BODY = 1
22
+ PDKIM_VERIFY_FAIL_MESSAGE = 2
23
+ PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE = 3
24
+ PDKIM_VERIFY_INVALID_BUFFER_SIZE = 4
25
+ PDKIM_VERIFY_INVALID_PUBKEY_PARSING = 5
26
+
27
+ def passed?
28
+ return verify_status == PDKIM_VERIFY_PASS
29
+ end
30
+
31
+ end
32
+
33
+ class Resolver
34
+ # finds the text records for a given domain and joins them into a single data field
35
+ def self.lookup_record(domain)
36
+ resolver = Dnsruby::DNS.new
37
+ resources = resolver.getresources(domain, Dnsruby::Types::TXT)
38
+ if resources
39
+ return resources.collect {|r| r.data}.join
40
+ else
41
+ return ""
42
+ end
43
+ end
44
+ end
45
+ end
data/rubydkim.gemspec ADDED
@@ -0,0 +1,33 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ Gem::Specification.new do |s|
4
+ s.name = %q{rubydkim}
5
+ s.version = "0.3.1"
6
+
7
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
8
+ s.authors = ["Ian Ragsdale"]
9
+ s.date = %q{2010-07-24}
10
+ s.default_executable = %q{dkim_verify.rb}
11
+ s.description = %q{This is a DKIM implementation as a Ruby extension in C.}
12
+ s.email = %q{ian.ragsdale@gmail.com}
13
+ s.executables = ["dkim_sign.rb", "dkim_verify.rb"]
14
+ s.extensions = ["src/dkim/signer/extconf.rb", "src/dkim/verifier/extconf.rb"]
15
+ s.files = ["bin", "bin/dkim_sign.rb", "bin/dkim_verify.rb", "lib", "lib/dkim.rb", "LICENSE", "Rakefile", "README", "rubydkim.gemspec", "sample_key", "sample_key.pub", "src", "src/dkim", "src/dkim/signer", "src/dkim/signer/extconf.rb", "src/dkim/signer/signer.c", "src/dkim/verifier", "src/dkim/verifier/extconf.rb", "src/dkim/verifier/verifier.c", "VERSION"]
16
+ s.homepage = %q{http://github.com/iragsdale/rubydkim}
17
+ s.require_paths = ["lib", "lib"]
18
+ s.rubygems_version = %q{1.3.1}
19
+ s.summary = %q{A gem for creating & verifying DKIM signatures}
20
+
21
+ if s.respond_to? :specification_version then
22
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
23
+ s.specification_version = 2
24
+
25
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
26
+ s.add_runtime_dependency(%q<dnsruby>, [">= 0"])
27
+ else
28
+ s.add_dependency(%q<dnsruby>, [">= 0"])
29
+ end
30
+ else
31
+ s.add_dependency(%q<dnsruby>, [">= 0"])
32
+ end
33
+ end
data/sample_key ADDED
@@ -0,0 +1,10 @@
1
+ -----BEGIN RSA PRIVATE KEY-----
2
+ MIIBOgIBAAJBAJprNumJN5trpHDmbuuWEzoL93/nlr1ATiFdBvaCRS3vGQ2EtObn
3
+ zIIM/NltcBMLr5/mDCDfbPn/2qiXobMbzl8CAwEAAQJAY6Cmxhfky56wcrMJf2/N
4
+ KddMsLYPWDzj67ykYGj+DzrCgilzgJFo/TECYQOOvf7WkQoj8AJ+twlF806e6WxU
5
+ YQIhAMjDmSuaXQZ3Mpce0PsHlcmlWlS80g5eXOFmj6/hXsJPAiEAxOdiXnCBiYZM
6
+ EnfWS/lg4tM3xxhbYfog3SAfaQl8fvECICm/Ys6KXuXFS6PZKKPKw/8Wf143lYaf
7
+ YLkOVrrAJrBJAiAuu0OrakQ0IX14fJyNl3gZHUwFopA9pqGaGX+a7Ddx4QIhALD0
8
+ ds9nZTU44VHhUmxn1L9Z+8kFy20obuMtNzAMJSMF
9
+ -----END RSA PRIVATE KEY-----
10
+
data/sample_key.pub ADDED
@@ -0,0 +1,2 @@
1
+ ssh-rsa MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJprNumJN5trpHDmbuuWEzoL93/nlr1ATiFdBvaCRS3vGQ2EtObnzIIM/NltcBMLr5/mDCDfbPn/2qiXobMbzl8CAwEAAQ==
2
+
@@ -0,0 +1,7 @@
1
+ require 'mkmf'
2
+ # link against pdkim
3
+ if have_library("pdkim1", "pdkim_init_sign")
4
+ create_makefile("signer")
5
+ else
6
+ puts "PDKIM library not found - please install it from http://duncanthrax.net/pdkim/"
7
+ end
@@ -0,0 +1,146 @@
1
+ #include "ruby.h"
2
+ #include "pdkim1.h"
3
+
4
+ #ifdef HAVE_RUBY_IO_H
5
+ #include "ruby/io.h"
6
+ #define GetWriteFile(fp) rb_io_stdio_file(fp)
7
+ #define OpenFile rb_io_t
8
+ #else
9
+ #include "rubyio.h"
10
+ #endif
11
+
12
+ static VALUE mDKIM, cDKIMSigner, cDKIMSignature, cTime;
13
+
14
+ // feed data to the dkim context
15
+ VALUE signer_feed(VALUE obj, VALUE text)
16
+ {
17
+ // get the dkim context
18
+ pdkim_ctx *ctx;
19
+ Data_Get_Struct(obj, pdkim_ctx, ctx);
20
+
21
+ // get the text data
22
+ char * data = StringValuePtr(text);
23
+
24
+ // pass the string data to pdkim_feed while setting the length
25
+ if ( pdkim_feed(ctx, data, strlen(data)) != PDKIM_OK) {
26
+ printf("pdkim_feed() error\n");
27
+ }
28
+ return Qnil;
29
+ }
30
+
31
+ // create a signature object from a pdkim_signature
32
+ VALUE new_signature(pdkim_signature *sig)
33
+ {
34
+ VALUE rsig = rb_funcall(cDKIMSignature, rb_intern("new"), 0);
35
+ if (sig->version > 0)
36
+ rb_iv_set(rsig, "@version", INT2FIX(sig->version));
37
+ rb_iv_set(rsig, "@algo", INT2FIX(sig->algo));
38
+ rb_iv_set(rsig, "@canon_headers", INT2FIX(sig->canon_headers));
39
+ rb_iv_set(rsig, "@canon_body", INT2FIX(sig->canon_body));
40
+ rb_iv_set(rsig, "@querymethod", INT2FIX(sig->querymethod));
41
+ if (sig->selector != NULL)
42
+ rb_iv_set(rsig, "@selector", rb_str_new2(sig->selector));
43
+ if (sig->domain != NULL)
44
+ rb_iv_set(rsig, "@domain", rb_str_new2(sig->domain));
45
+ if (sig->identity != NULL)
46
+ rb_iv_set(rsig, "@identity", rb_str_new2(sig->identity));
47
+ if (sig->created > 0)
48
+ rb_iv_set(rsig, "@created", rb_funcall(cTime, rb_intern("at"), 1, INT2FIX(sig->created)));
49
+ if (sig->expires > 0)
50
+ rb_iv_set(rsig, "@expires", rb_funcall(cTime, rb_intern("at"), 1, INT2FIX(sig->expires)));
51
+ rb_iv_set(rsig, "@bodylength", INT2FIX(sig->bodylength));
52
+ if (sig->headernames != NULL)
53
+ rb_iv_set(rsig, "@headernames", rb_str_new2(sig->headernames));
54
+ if (sig->copiedheaders != NULL)
55
+ rb_iv_set(rsig, "@copiedheaders", rb_str_new2(sig->copiedheaders));
56
+ if (sig->signature_header != NULL)
57
+ rb_iv_set(rsig, "@signature_header", rb_str_new2(sig->signature_header));
58
+ rb_iv_set(rsig, "@verify_status", INT2FIX(sig->verify_status));
59
+ rb_iv_set(rsig, "@verify_ext_status", INT2FIX(sig->verify_ext_status));
60
+ // rb_iv_set(rsig, "@pubkey", );
61
+ return rsig;
62
+ }
63
+
64
+ // finish sending message data and return the signature
65
+ VALUE signer_finish(VALUE obj)
66
+ {
67
+ // get the dkim context
68
+ pdkim_ctx *ctx;
69
+ Data_Get_Struct(obj, pdkim_ctx, ctx);
70
+
71
+ // create a signature object
72
+ pdkim_signature *signature;
73
+ int result = pdkim_feed_finish(ctx,&signature);
74
+ if ( result == PDKIM_OK ) {
75
+ return new_signature(signature);
76
+ }
77
+ else {
78
+ rb_raise(rb_eRuntimeError, "error finishing signature: %d", result);
79
+ }
80
+ }
81
+
82
+ // frees the class when we're done
83
+ static void signer_free(void *ctx) {
84
+ pdkim_free_ctx(ctx);
85
+ }
86
+
87
+ // initializes the signer object
88
+ static VALUE signer_init(VALUE self) {
89
+ return self;
90
+ }
91
+
92
+ // allocates a new dkim object
93
+ VALUE signer_new(VALUE class, VALUE domain, VALUE selector, VALUE key)
94
+ {
95
+ // create the DKIM context
96
+ pdkim_ctx *ctx = pdkim_init_sign(PDKIM_INPUT_NORMAL, /* Input type */
97
+ STR2CSTR(domain), /* Domain */
98
+ STR2CSTR(selector), /* Selector */
99
+ STR2CSTR(key) /* Private RSA key */
100
+ );
101
+
102
+ // wrap it into our class
103
+ VALUE obj = Data_Wrap_Struct(class, 0, signer_free, ctx);
104
+
105
+ // initialize and return it
106
+ rb_obj_call_init(obj, 0, 0);
107
+ return obj;
108
+ }
109
+
110
+ // sends debugging output to the given file
111
+ VALUE signer_debug(VALUE obj, VALUE file)
112
+ {
113
+ // get the dkim context
114
+ pdkim_ctx *ctx;
115
+ Data_Get_Struct(obj, pdkim_ctx, ctx);
116
+
117
+ // if we were given a nil object, turn debugging off
118
+ if (TYPE(file) == T_NIL) {
119
+ pdkim_set_debug_stream(ctx, NULL);
120
+ }
121
+ // if we were given a file, use it for debugging
122
+ else if (TYPE(file) == T_FILE) {
123
+ OpenFile *openfile = NULL;
124
+ GetOpenFile(file, openfile);
125
+ pdkim_set_debug_stream(ctx, GetWriteFile(openfile));
126
+ }
127
+ // otherwise, raise an exception
128
+ else {
129
+ rb_raise(rb_eTypeError, "debug requires a file handle");
130
+ }
131
+ return T_NONE;
132
+ }
133
+
134
+ // defines the new ruby class and hooks up the proper methods
135
+ void Init_signer() {
136
+ mDKIM = rb_define_module("DKIM");
137
+ cDKIMSigner = rb_define_class_under(mDKIM, "Signer", rb_cObject);
138
+ cDKIMSignature = rb_define_class_under(mDKIM, "Signature", rb_cObject);
139
+ cTime = rb_define_class("Time", rb_cObject);
140
+ rb_define_singleton_method(cDKIMSigner, "new", signer_new, 3);
141
+ rb_define_method(cDKIMSigner, "initialize", signer_init, 0);
142
+ rb_define_method(cDKIMSigner, "feed", signer_feed, 1);
143
+ rb_define_method(cDKIMSigner, "finish", signer_finish, 0);
144
+ rb_define_method(cDKIMSigner, "debug", signer_debug, 1);
145
+ }
146
+
@@ -0,0 +1,7 @@
1
+ require 'mkmf'
2
+ # link against pdkim
3
+ if have_library("pdkim1", "pdkim_init_verify")
4
+ create_makefile("verifier")
5
+ else
6
+ puts "PDKIM library not found - please install it from http://duncanthrax.net/pdkim/"
7
+ end
@@ -0,0 +1,171 @@
1
+ #include "ruby.h"
2
+ #include "pdkim1.h"
3
+
4
+ #ifdef HAVE_RUBY_IO_H
5
+ #include "ruby/io.h"
6
+ #define GetWriteFile(fp) rb_io_stdio_file(fp)
7
+ #define OpenFile rb_io_t
8
+ #else
9
+ #include "rubyio.h"
10
+ #endif
11
+
12
+ static VALUE mDKIM, cDKIMVerifier, cDKIMResolver, cDKIMSignature, cTime;
13
+
14
+ // feed data to the dkim context
15
+ VALUE verifier_feed(VALUE obj, VALUE text)
16
+ {
17
+ // get the dkim context
18
+ pdkim_ctx *ctx;
19
+ Data_Get_Struct(obj, pdkim_ctx, ctx);
20
+
21
+ // get the text data
22
+ char * data = StringValuePtr(text);
23
+
24
+ // pass the string data to pdkim_feed while setting the length
25
+ if ( pdkim_feed(ctx, data, strlen(data)) != PDKIM_OK) {
26
+ printf("pdkim_feed() error\n");
27
+ }
28
+ return Qnil;
29
+ }
30
+
31
+ // create a signature object from a pdkim_signature
32
+ VALUE new_signature(pdkim_signature *sig)
33
+ {
34
+ VALUE rsig = rb_funcall(cDKIMSignature, rb_intern("new"), 0);
35
+ if (sig->version > 0)
36
+ rb_iv_set(rsig, "@version", INT2FIX(sig->version));
37
+ rb_iv_set(rsig, "@algo", INT2FIX(sig->algo));
38
+ rb_iv_set(rsig, "@canon_headers", INT2FIX(sig->canon_headers));
39
+ rb_iv_set(rsig, "@canon_body", INT2FIX(sig->canon_body));
40
+ rb_iv_set(rsig, "@querymethod", INT2FIX(sig->querymethod));
41
+ if (sig->selector != NULL)
42
+ rb_iv_set(rsig, "@selector", rb_str_new2(sig->selector));
43
+ if (sig->domain != NULL)
44
+ rb_iv_set(rsig, "@domain", rb_str_new2(sig->domain));
45
+ if (sig->identity != NULL)
46
+ rb_iv_set(rsig, "@identity", rb_str_new2(sig->identity));
47
+ if (sig->created > 0)
48
+ rb_iv_set(rsig, "@created", rb_funcall(cTime, rb_intern("at"), 1, INT2FIX(sig->created)));
49
+ if (sig->expires > 0)
50
+ rb_iv_set(rsig, "@expires", rb_funcall(cTime, rb_intern("at"), 1, INT2FIX(sig->expires)));
51
+ rb_iv_set(rsig, "@bodylength", INT2FIX(sig->bodylength));
52
+ if (sig->headernames != NULL)
53
+ rb_iv_set(rsig, "@headernames", rb_str_new2(sig->headernames));
54
+ if (sig->copiedheaders != NULL)
55
+ rb_iv_set(rsig, "@copiedheaders", rb_str_new2(sig->copiedheaders));
56
+ if (sig->signature_header != NULL)
57
+ rb_iv_set(rsig, "@signature_header", rb_str_new2(sig->signature_header));
58
+ rb_iv_set(rsig, "@verify_status", INT2FIX(sig->verify_status));
59
+ rb_iv_set(rsig, "@verify_ext_status", INT2FIX(sig->verify_ext_status));
60
+ // rb_iv_set(rsig, "@pubkey", );
61
+ return rsig;
62
+ }
63
+
64
+
65
+ // finish sending message data and return the signature
66
+ VALUE verifier_finish(VALUE obj)
67
+ {
68
+ // get the dkim context
69
+ pdkim_ctx *ctx;
70
+ Data_Get_Struct(obj, pdkim_ctx, ctx);
71
+
72
+ // finish up the call
73
+ pdkim_signature *signatures;
74
+
75
+ int result = pdkim_feed_finish(ctx,&signatures);
76
+ if ( result == PDKIM_OK ) {
77
+
78
+ // create an array to hold the new signatures
79
+ VALUE rsigs = rb_ary_new();
80
+
81
+ // step through the list of signatues
82
+ while (signatures != NULL) {
83
+
84
+ // add each signature to the array
85
+ rb_ary_push(rsigs, new_signature(signatures));
86
+
87
+ // look for another signature
88
+ signatures = signatures->next;
89
+ }
90
+ return rsigs;
91
+ }
92
+ else {
93
+ rb_raise(rb_eRuntimeError, "error finishing signature: %d", result);
94
+ }
95
+ }
96
+
97
+ // looks up the DNS record given
98
+ int query_dns_txt(char *name, char *answer) {
99
+ // call the lookup_record function from the ruby resolver lib
100
+ // this lets us customize resolution in ruby
101
+ VALUE record = rb_funcall(cDKIMResolver, rb_intern("lookup_record"), 1, rb_str_new2(name));
102
+
103
+ // copy the results to the context
104
+ strcpy(answer, STR2CSTR(record));
105
+ return PDKIM_OK;
106
+ }
107
+
108
+ // frees the class when we're done
109
+ static void verifier_free(void *ctx) {
110
+ pdkim_free_ctx(ctx);
111
+ }
112
+
113
+ // initializes the verifier object
114
+ static VALUE verifier_init(VALUE self) {
115
+ return self;
116
+ }
117
+
118
+ // allocates a new dkim verifier object
119
+ VALUE verifier_new(VALUE class)
120
+ {
121
+ // create the DKIM context
122
+ pdkim_ctx *ctx = pdkim_init_verify(PDKIM_INPUT_NORMAL,
123
+ &query_dns_txt
124
+ );
125
+
126
+ // wrap it into our class
127
+ VALUE obj = Data_Wrap_Struct(class, 0, verifier_free, ctx);
128
+
129
+ // initialize and return it
130
+ rb_obj_call_init(obj, 0, 0);
131
+ return obj;
132
+ }
133
+
134
+ // sends debugging output to the given file
135
+ VALUE verifier_debug(VALUE obj, VALUE file)
136
+ {
137
+ // get the dkim context
138
+ pdkim_ctx *ctx;
139
+ Data_Get_Struct(obj, pdkim_ctx, ctx);
140
+
141
+ // if we were given a nil object, turn debugging off
142
+ if (TYPE(file) == T_NIL) {
143
+ pdkim_set_debug_stream(ctx, NULL);
144
+ }
145
+ // if we were given a file, use it for debugging
146
+ else if (TYPE(file) == T_FILE) {
147
+ OpenFile *openfile = NULL;
148
+ GetOpenFile(file, openfile);
149
+ pdkim_set_debug_stream(ctx, GetWriteFile(openfile));
150
+ }
151
+ // otherwise, raise an exception
152
+ else {
153
+ rb_raise(rb_eTypeError, "debug requires a file handle");
154
+ }
155
+ return Qnil;
156
+ }
157
+
158
+ // defines the new ruby class and hooks up the proper methods
159
+ void Init_verifier() {
160
+ mDKIM = rb_define_module("DKIM");
161
+ cDKIMVerifier = rb_define_class_under(mDKIM, "Verifier", rb_cObject);
162
+ cDKIMResolver = rb_define_class_under(mDKIM, "Resolver", rb_cObject);
163
+ cDKIMSignature = rb_define_class_under(mDKIM, "Signature", rb_cObject);
164
+ cTime = rb_define_class("Time", rb_cObject);
165
+ rb_define_singleton_method(cDKIMVerifier, "new", verifier_new, 0);
166
+ rb_define_method(cDKIMVerifier, "initialize", verifier_init, 0);
167
+ rb_define_method(cDKIMVerifier, "feed", verifier_feed, 1);
168
+ rb_define_method(cDKIMVerifier, "finish", verifier_finish, 0);
169
+ rb_define_method(cDKIMVerifier, "debug", verifier_debug, 1);
170
+ }
171
+
metadata ADDED
@@ -0,0 +1,96 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: rubydkim
3
+ version: !ruby/object:Gem::Version
4
+ hash: 17
5
+ prerelease: false
6
+ segments:
7
+ - 0
8
+ - 3
9
+ - 1
10
+ version: 0.3.1
11
+ platform: ruby
12
+ authors:
13
+ - Ian Ragsdale
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2010-07-24 00:00:00 -05:00
19
+ default_executable: dkim_verify.rb
20
+ dependencies:
21
+ - !ruby/object:Gem::Dependency
22
+ name: dnsruby
23
+ prerelease: false
24
+ requirement: &id001 !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ hash: 3
30
+ segments:
31
+ - 0
32
+ version: "0"
33
+ type: :runtime
34
+ version_requirements: *id001
35
+ description: This is a DKIM implementation as a Ruby extension in C.
36
+ email: ian.ragsdale@gmail.com
37
+ executables:
38
+ - dkim_sign.rb
39
+ - dkim_verify.rb
40
+ extensions:
41
+ - src/dkim/signer/extconf.rb
42
+ - src/dkim/verifier/extconf.rb
43
+ extra_rdoc_files: []
44
+
45
+ files:
46
+ - bin/dkim_sign.rb
47
+ - bin/dkim_verify.rb
48
+ - lib/dkim.rb
49
+ - LICENSE
50
+ - Rakefile
51
+ - README
52
+ - rubydkim.gemspec
53
+ - sample_key
54
+ - sample_key.pub
55
+ - src/dkim/signer/extconf.rb
56
+ - src/dkim/signer/signer.c
57
+ - src/dkim/verifier/extconf.rb
58
+ - src/dkim/verifier/verifier.c
59
+ - VERSION
60
+ has_rdoc: true
61
+ homepage: http://github.com/iragsdale/rubydkim
62
+ licenses: []
63
+
64
+ post_install_message:
65
+ rdoc_options: []
66
+
67
+ require_paths:
68
+ - lib
69
+ - lib
70
+ required_ruby_version: !ruby/object:Gem::Requirement
71
+ none: false
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ hash: 3
76
+ segments:
77
+ - 0
78
+ version: "0"
79
+ required_rubygems_version: !ruby/object:Gem::Requirement
80
+ none: false
81
+ requirements:
82
+ - - ">="
83
+ - !ruby/object:Gem::Version
84
+ hash: 3
85
+ segments:
86
+ - 0
87
+ version: "0"
88
+ requirements: []
89
+
90
+ rubyforge_project:
91
+ rubygems_version: 1.3.7
92
+ signing_key:
93
+ specification_version: 2
94
+ summary: A gem for creating & verifying DKIM signatures
95
+ test_files: []
96
+