arachni-rpc 0.1

Sign up to get free protection for your applications and to get access to all the features.
data/CHANGELOG.md ADDED
File without changes
data/LICENSE.md ADDED
@@ -0,0 +1,341 @@
1
+ # License
2
+
3
+ GNU GENERAL PUBLIC LICENSE
4
+ Version 2, June 1991
5
+
6
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
7
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
8
+ Everyone is permitted to copy and distribute verbatim copies
9
+ of this license document, but changing it is not allowed.
10
+
11
+ Preamble
12
+
13
+ The licenses for most software are designed to take away your
14
+ freedom to share and change it. By contrast, the GNU General Public
15
+ License is intended to guarantee your freedom to share and change free
16
+ software--to make sure the software is free for all its users. This
17
+ General Public License applies to most of the Free Software
18
+ Foundation's software and to any other program whose authors commit to
19
+ using it. (Some other Free Software Foundation software is covered by
20
+ the GNU Lesser General Public License instead.) You can apply it to
21
+ your programs, too.
22
+
23
+ When we speak of free software, we are referring to freedom, not
24
+ price. Our General Public Licenses are designed to make sure that you
25
+ have the freedom to distribute copies of free software (and charge for
26
+ this service if you wish), that you receive source code or can get it
27
+ if you want it, that you can change the software or use pieces of it
28
+ in new free programs; and that you know you can do these things.
29
+
30
+ To protect your rights, we need to make restrictions that forbid
31
+ anyone to deny you these rights or to ask you to surrender the rights.
32
+ These restrictions translate to certain responsibilities for you if you
33
+ distribute copies of the software, or if you modify it.
34
+
35
+ For example, if you distribute copies of such a program, whether
36
+ gratis or for a fee, you must give the recipients all the rights that
37
+ you have. You must make sure that they, too, receive or can get the
38
+ source code. And you must show them these terms so they know their
39
+ rights.
40
+
41
+ We protect your rights with two steps: (1) copyright the software, and
42
+ (2) offer you this license which gives you legal permission to copy,
43
+ distribute and/or modify the software.
44
+
45
+ Also, for each author's protection and ours, we want to make certain
46
+ that everyone understands that there is no warranty for this free
47
+ software. If the software is modified by someone else and passed on, we
48
+ want its recipients to know that what they have is not the original, so
49
+ that any problems introduced by others will not reflect on the original
50
+ authors' reputations.
51
+
52
+ Finally, any free program is threatened constantly by software
53
+ patents. We wish to avoid the danger that redistributors of a free
54
+ program will individually obtain patent licenses, in effect making the
55
+ program proprietary. To prevent this, we have made it clear that any
56
+ patent must be licensed for everyone's free use or not licensed at all.
57
+
58
+ The precise terms and conditions for copying, distribution and
59
+ modification follow.
60
+
61
+ GNU GENERAL PUBLIC LICENSE
62
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
63
+
64
+ 0. This License applies to any program or other work which contains
65
+ a notice placed by the copyright holder saying it may be distributed
66
+ under the terms of this General Public License. The "Program", below,
67
+ refers to any such program or work, and a "work based on the Program"
68
+ means either the Program or any derivative work under copyright law:
69
+ that is to say, a work containing the Program or a portion of it,
70
+ either verbatim or with modifications and/or translated into another
71
+ language. (Hereinafter, translation is included without limitation in
72
+ the term "modification".) Each licensee is addressed as "you".
73
+
74
+ Activities other than copying, distribution and modification are not
75
+ covered by this License; they are outside its scope. The act of
76
+ running the Program is not restricted, and the output from the Program
77
+ is covered only if its contents constitute a work based on the
78
+ Program (independent of having been made by running the Program).
79
+ Whether that is true depends on what the Program does.
80
+
81
+ 1. You may copy and distribute verbatim copies of the Program's
82
+ source code as you receive it, in any medium, provided that you
83
+ conspicuously and appropriately publish on each copy an appropriate
84
+ copyright notice and disclaimer of warranty; keep intact all the
85
+ notices that refer to this License and to the absence of any warranty;
86
+ and give any other recipients of the Program a copy of this License
87
+ along with the Program.
88
+
89
+ You may charge a fee for the physical act of transferring a copy, and
90
+ you may at your option offer warranty protection in exchange for a fee.
91
+
92
+ 2. You may modify your copy or copies of the Program or any portion
93
+ of it, thus forming a work based on the Program, and copy and
94
+ distribute such modifications or work under the terms of Section 1
95
+ above, provided that you also meet all of these conditions:
96
+
97
+ a) You must cause the modified files to carry prominent notices
98
+ stating that you changed the files and the date of any change.
99
+
100
+ b) You must cause any work that you distribute or publish, that in
101
+ whole or in part contains or is derived from the Program or any
102
+ part thereof, to be licensed as a whole at no charge to all third
103
+ parties under the terms of this License.
104
+
105
+ c) If the modified program normally reads commands interactively
106
+ when run, you must cause it, when started running for such
107
+ interactive use in the most ordinary way, to print or display an
108
+ announcement including an appropriate copyright notice and a
109
+ notice that there is no warranty (or else, saying that you provide
110
+ a warranty) and that users may redistribute the program under
111
+ these conditions, and telling the user how to view a copy of this
112
+ License. (Exception: if the Program itself is interactive but
113
+ does not normally print such an announcement, your work based on
114
+ the Program is not required to print an announcement.)
115
+
116
+ These requirements apply to the modified work as a whole. If
117
+ identifiable sections of that work are not derived from the Program,
118
+ and can be reasonably considered independent and separate works in
119
+ themselves, then this License, and its terms, do not apply to those
120
+ sections when you distribute them as separate works. But when you
121
+ distribute the same sections as part of a whole which is a work based
122
+ on the Program, the distribution of the whole must be on the terms of
123
+ this License, whose permissions for other licensees extend to the
124
+ entire whole, and thus to each and every part regardless of who wrote it.
125
+
126
+ Thus, it is not the intent of this section to claim rights or contest
127
+ your rights to work written entirely by you; rather, the intent is to
128
+ exercise the right to control the distribution of derivative or
129
+ collective works based on the Program.
130
+
131
+ In addition, mere aggregation of another work not based on the Program
132
+ with the Program (or with a work based on the Program) on a volume of
133
+ a storage or distribution medium does not bring the other work under
134
+ the scope of this License.
135
+
136
+ 3. You may copy and distribute the Program (or a work based on it,
137
+ under Section 2) in object code or executable form under the terms of
138
+ Sections 1 and 2 above provided that you also do one of the following:
139
+
140
+ a) Accompany it with the complete corresponding machine-readable
141
+ source code, which must be distributed under the terms of Sections
142
+ 1 and 2 above on a medium customarily used for software interchange; or,
143
+
144
+ b) Accompany it with a written offer, valid for at least three
145
+ years, to give any third party, for a charge no more than your
146
+ cost of physically performing source distribution, a complete
147
+ machine-readable copy of the corresponding source code, to be
148
+ distributed under the terms of Sections 1 and 2 above on a medium
149
+ customarily used for software interchange; or,
150
+
151
+ c) Accompany it with the information you received as to the offer
152
+ to distribute corresponding source code. (This alternative is
153
+ allowed only for noncommercial distribution and only if you
154
+ received the program in object code or executable form with such
155
+ an offer, in accord with Subsection b above.)
156
+
157
+ The source code for a work means the preferred form of the work for
158
+ making modifications to it. For an executable work, complete source
159
+ code means all the source code for all modules it contains, plus any
160
+ associated interface definition files, plus the scripts used to
161
+ control compilation and installation of the executable. However, as a
162
+ special exception, the source code distributed need not include
163
+ anything that is normally distributed (in either source or binary
164
+ form) with the major components (compiler, kernel, and so on) of the
165
+ operating system on which the executable runs, unless that component
166
+ itself accompanies the executable.
167
+
168
+ If distribution of executable or object code is made by offering
169
+ access to copy from a designated place, then offering equivalent
170
+ access to copy the source code from the same place counts as
171
+ distribution of the source code, even though third parties are not
172
+ compelled to copy the source along with the object code.
173
+
174
+ 4. You may not copy, modify, sublicense, or distribute the Program
175
+ except as expressly provided under this License. Any attempt
176
+ otherwise to copy, modify, sublicense or distribute the Program is
177
+ void, and will automatically terminate your rights under this License.
178
+ However, parties who have received copies, or rights, from you under
179
+ this License will not have their licenses terminated so long as such
180
+ parties remain in full compliance.
181
+
182
+ 5. You are not required to accept this License, since you have not
183
+ signed it. However, nothing else grants you permission to modify or
184
+ distribute the Program or its derivative works. These actions are
185
+ prohibited by law if you do not accept this License. Therefore, by
186
+ modifying or distributing the Program (or any work based on the
187
+ Program), you indicate your acceptance of this License to do so, and
188
+ all its terms and conditions for copying, distributing or modifying
189
+ the Program or works based on it.
190
+
191
+ 6. Each time you redistribute the Program (or any work based on the
192
+ Program), the recipient automatically receives a license from the
193
+ original licensor to copy, distribute or modify the Program subject to
194
+ these terms and conditions. You may not impose any further
195
+ restrictions on the recipients' exercise of the rights granted herein.
196
+ You are not responsible for enforcing compliance by third parties to
197
+ this License.
198
+
199
+ 7. If, as a consequence of a court judgment or allegation of patent
200
+ infringement or for any other reason (not limited to patent issues),
201
+ conditions are imposed on you (whether by court order, agreement or
202
+ otherwise) that contradict the conditions of this License, they do not
203
+ excuse you from the conditions of this License. If you cannot
204
+ distribute so as to satisfy simultaneously your obligations under this
205
+ License and any other pertinent obligations, then as a consequence you
206
+ may not distribute the Program at all. For example, if a patent
207
+ license would not permit royalty-free redistribution of the Program by
208
+ all those who receive copies directly or indirectly through you, then
209
+ the only way you could satisfy both it and this License would be to
210
+ refrain entirely from distribution of the Program.
211
+
212
+ If any portion of this section is held invalid or unenforceable under
213
+ any particular circumstance, the balance of the section is intended to
214
+ apply and the section as a whole is intended to apply in other
215
+ circumstances.
216
+
217
+ It is not the purpose of this section to induce you to infringe any
218
+ patents or other property right claims or to contest validity of any
219
+ such claims; this section has the sole purpose of protecting the
220
+ integrity of the free software distribution system, which is
221
+ implemented by public license practices. Many people have made
222
+ generous contributions to the wide range of software distributed
223
+ through that system in reliance on consistent application of that
224
+ system; it is up to the author/donor to decide if he or she is willing
225
+ to distribute software through any other system and a licensee cannot
226
+ impose that choice.
227
+
228
+ This section is intended to make thoroughly clear what is believed to
229
+ be a consequence of the rest of this License.
230
+
231
+ 8. If the distribution and/or use of the Program is restricted in
232
+ certain countries either by patents or by copyrighted interfaces, the
233
+ original copyright holder who places the Program under this License
234
+ may add an explicit geographical distribution limitation excluding
235
+ those countries, so that distribution is permitted only in or among
236
+ countries not thus excluded. In such case, this License incorporates
237
+ the limitation as if written in the body of this License.
238
+
239
+ 9. The Free Software Foundation may publish revised and/or new versions
240
+ of the General Public License from time to time. Such new versions will
241
+ be similar in spirit to the present version, but may differ in detail to
242
+ address new problems or concerns.
243
+
244
+ Each version is given a distinguishing version number. If the Program
245
+ specifies a version number of this License which applies to it and "any
246
+ later version", you have the option of following the terms and conditions
247
+ either of that version or of any later version published by the Free
248
+ Software Foundation. If the Program does not specify a version number of
249
+ this License, you may choose any version ever published by the Free Software
250
+ Foundation.
251
+
252
+ 10. If you wish to incorporate parts of the Program into other free
253
+ programs whose distribution conditions are different, write to the author
254
+ to ask for permission. For software which is copyrighted by the Free
255
+ Software Foundation, write to the Free Software Foundation; we sometimes
256
+ make exceptions for this. Our decision will be guided by the two goals
257
+ of preserving the free status of all derivatives of our free software and
258
+ of promoting the sharing and reuse of software generally.
259
+
260
+ NO WARRANTY
261
+
262
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
263
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
264
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
265
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
266
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
267
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
268
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
269
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
270
+ REPAIR OR CORRECTION.
271
+
272
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
273
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
274
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
275
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
276
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
277
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
278
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
279
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
280
+ POSSIBILITY OF SUCH DAMAGES.
281
+
282
+ END OF TERMS AND CONDITIONS
283
+
284
+ How to Apply These Terms to Your New Programs
285
+
286
+ If you develop a new program, and you want it to be of the greatest
287
+ possible use to the public, the best way to achieve this is to make it
288
+ free software which everyone can redistribute and change under these terms.
289
+
290
+ To do so, attach the following notices to the program. It is safest
291
+ to attach them to the start of each source file to most effectively
292
+ convey the exclusion of warranty; and each file should have at least
293
+ the "copyright" line and a pointer to where the full notice is found.
294
+
295
+ <one line to give the program's name and a brief idea of what it does.>
296
+ Copyright (C) <year> <name of author>
297
+
298
+ This program is free software; you can redistribute it and/or modify
299
+ it under the terms of the GNU General Public License as published by
300
+ the Free Software Foundation; either version 2 of the License, or
301
+ (at your option) any later version.
302
+
303
+ This program is distributed in the hope that it will be useful,
304
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
305
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
306
+ GNU General Public License for more details.
307
+
308
+ You should have received a copy of the GNU General Public License along
309
+ with this program; if not, write to the Free Software Foundation, Inc.,
310
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
311
+
312
+ Also add information on how to contact you by electronic and paper mail.
313
+
314
+ If the program is interactive, make it output a short notice like this
315
+ when it starts in an interactive mode:
316
+
317
+ Gnomovision version 69, Copyright (C) year name of author
318
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
319
+ This is free software, and you are welcome to redistribute it
320
+ under certain conditions; type `show c' for details.
321
+
322
+ The hypothetical commands `show w' and `show c' should show the appropriate
323
+ parts of the General Public License. Of course, the commands you use may
324
+ be called something other than `show w' and `show c'; they could even be
325
+ mouse-clicks or menu items--whatever suits your program.
326
+
327
+ You should also get your employer (if you work as a programmer) or your
328
+ school, if any, to sign a "copyright disclaimer" for the program, if
329
+ necessary. Here is a sample; alter the names:
330
+
331
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
332
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
333
+
334
+ <signature of Ty Coon>, 1 April 1989
335
+ Ty Coon, President of Vice
336
+
337
+ This General Public License does not permit incorporating your program into
338
+ proprietary programs. If your program is a subroutine library, you may
339
+ consider it more useful to permit linking proprietary applications with the
340
+ library. If this is what you want to do, use the GNU Lesser General
341
+ Public License instead of this License.
data/README.md ADDED
@@ -0,0 +1,89 @@
1
+ # Arachni-RPC
2
+ <table>
3
+ <tr>
4
+ <th>Version</th>
5
+ <td>0.1</td>
6
+ </tr>
7
+ <tr>
8
+ <th>Github page</th>
9
+ <td><a href="http://github.com/Arachni/arachni-rpc">http://github.com/Arachni/arachni-rpc</a></td>
10
+ <tr/>
11
+ <tr>
12
+ <th>Code Documentation</th>
13
+ <td><a href="http://rubydoc.info/github/Arachni/arachni-rpc/">http://rubydoc.info/github/Arachni/arachni-rpc/</a></td>
14
+ </tr>
15
+ <tr>
16
+ <th>Author</th>
17
+ <td><a href="mailto:tasos.laskos@gmail.com">Tasos</a> "<a href="mailto:zapotek@segfault.gr">Zapotek</a>" <a href="mailto:tasos.laskos@gmail.com">Laskos</a></td>
18
+ </tr>
19
+ <tr>
20
+ <th>Twitter</th>
21
+ <td><a href="http://twitter.com/Zap0tek">@Zap0tek</a></td>
22
+ </tr>
23
+ <tr>
24
+ <th>Copyright</th>
25
+ <td>2011</td>
26
+ </tr>
27
+ <tr>
28
+ <th>License</th>
29
+ <td><a href="file.LICENSE.html">GNU General Public License v2</a></td>
30
+ </tr>
31
+ </table>
32
+
33
+ ## Synopsis
34
+
35
+ Arachni-RPC is a simple and lightweight Remote Procedure Call protocol which provides the basis for <a href="http://arachni.segfault.gr">Arachni</a>'s Grid infrastructure.
36
+
37
+ This repository holds *only* the protocol specification although there currently are 2 (more like 1.5) available implementations:
38
+
39
+ - <a href="http://github.com/Arachni/arachni-rpc-em">Arachni-RPC EM</a> -- Uses EventMachine for network related operations and provides both a client and a server, this is the one used by Arachni.
40
+ - <a href="http://github.com/Arachni/arachni-rpc-pure">Arachni-RPC Pure</a> -- Provides a synchronous client using pure Ruby OpenSSL sockets and has no 3rd party dependencies.
41
+
42
+ ## Features
43
+
44
+ It is:
45
+
46
+ - extremely lightweight
47
+ - very simple design
48
+ - provides token-based authentication
49
+
50
+ ## Installation
51
+
52
+ I can't think of a lot of uses for manually installing the protocol specification
53
+ (it'll most likely be installed as a dependency for some other project) but in case you want to some instructions follow.
54
+
55
+ ### Gem
56
+
57
+ The Gem hasn't been pushed yet, the system is still under development.
58
+
59
+ ### Source
60
+
61
+ If you want to clone the repository and work with the source code:
62
+
63
+ git co git://github.com/arachni/arachni-rpc.git
64
+ cd arachni-rpc
65
+ rake install
66
+
67
+
68
+ ## Running the Specs
69
+
70
+ In order to run the specs you must first install RSpec:
71
+ gem install rspec
72
+
73
+ Then:
74
+
75
+ rake spec
76
+
77
+ ## Protocol specifications
78
+
79
+ You can find that information in the [Wiki](https://github.com/Arachni/arachni-rpc/wiki).
80
+
81
+ ## Bug reports/Feature requests
82
+ Please send your feedback using Github's issue system at
83
+ [http://github.com/arachni/arachni-rpc/issues](http://github.com/arachni/arachni-rpc/issues).
84
+
85
+
86
+ ## License
87
+ Arachni is licensed under the GNU General Public License v2.<br/>
88
+ See the [LICENSE](file.LICENSE.html) file for more information.
89
+
data/Rakefile ADDED
@@ -0,0 +1,80 @@
1
+ =begin
2
+ Arachni
3
+ Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
4
+
5
+ This is free software; you can copy and distribute and modify
6
+ this program under the term of the GPL v2.0 License
7
+ (See LICENSE file for details)
8
+
9
+ =end
10
+
11
+ require 'rubygems'
12
+
13
+ begin
14
+ require 'rspec'
15
+ require 'rspec/core/rake_task'
16
+
17
+ RSpec::Core::RakeTask.new do |t|
18
+ t.rspec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
19
+ end
20
+ rescue
21
+ end
22
+
23
+ desc "Generate docs"
24
+
25
+ task :docs do
26
+
27
+ outdir = "../arachni-rpc-pages"
28
+ sh "mkdir #{outdir}" if !File.directory?( outdir )
29
+
30
+ sh "yardoc --verbose --title \
31
+ \"Arachni-RPC\" \
32
+ lib/* -o #{outdir} \
33
+ - CHANGELOG.md LICENSE.md"
34
+
35
+
36
+ sh "rm -rf .yard*"
37
+ end
38
+
39
+
40
+ #
41
+ # Cleans reports and logs
42
+ #
43
+ desc "Cleaning..."
44
+ task :clean do
45
+ sh "rm *.gem || true"
46
+ end
47
+
48
+
49
+
50
+ #
51
+ # Building
52
+ #
53
+ desc "Build the arachni-rpc gem."
54
+ task :build => [ :clean ] do
55
+ sh "gem build arachni-rpc.gemspec"
56
+ end
57
+
58
+
59
+ #
60
+ # Installing
61
+ #
62
+ desc "Build and install the arachni gem."
63
+ task :install => [ :build ] do
64
+
65
+ require File.expand_path( File.dirname( __FILE__ ) ) + '/lib/arachni/rpc/version'
66
+
67
+ sh "gem install arachni-rpc-#{Arachni::RPC::VERSION}.gem"
68
+ end
69
+
70
+
71
+ #
72
+ # Publishing
73
+ #
74
+ desc "Push a new version to Gemcutter"
75
+ task :publish => [ :build ] do
76
+
77
+ require File.expand_path( File.dirname( __FILE__ ) ) + '/lib/arachni/rpc/version'
78
+
79
+ sh "gem push arachni-rpc-#{Arachni::RPC::VERSION}.gem"
80
+ end
@@ -0,0 +1,20 @@
1
+ =begin
2
+ Arachni
3
+ Copyright (c) 2010-2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
4
+
5
+ This is free software; you can copy and distribute and modify
6
+ this program under the term of the GPL v2.0 License
7
+ (See LICENSE file for details)
8
+
9
+ =end
10
+
11
+ require 'set'
12
+ require 'yaml'
13
+
14
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'version' )
15
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'exceptions' )
16
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'message' )
17
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'request' )
18
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'response' )
19
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), 'rpc', 'remote_object_mapper' )
20
+
@@ -0,0 +1,178 @@
1
+ =begin
2
+ Arachni-RPC
3
+ Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
4
+
5
+ This is free software; you can copy and distribute and modify
6
+ this program under the term of the GPL v2.0 License
7
+ (See LICENSE file for details)
8
+
9
+ =end
10
+
11
+ #
12
+ # RPC Exceptions have methods that help identify them based on type.
13
+ #
14
+ # So in order to allow evaluations like:
15
+ #
16
+ # my_object.rpc_connection_error?
17
+ #
18
+ # to be possible on all objects these helper methods need to be available for
19
+ # all objects.
20
+ #
21
+ # By default they'll return false, individual RPC Exceptions will overwrite them to
22
+ # return true when applicable.
23
+ #
24
+ class Object
25
+
26
+ # @return [Bool] false
27
+ def rpc_connection_error?
28
+ false
29
+ end
30
+
31
+ # @return [Bool] false
32
+ def rpc_remote_exception?
33
+ false
34
+ end
35
+
36
+ # @return [Bool] false
37
+ def rpc_invalid_object_error?
38
+ false
39
+ end
40
+
41
+ # @return [Bool] false
42
+ def rpc_invalid_method_error?
43
+ false
44
+ end
45
+
46
+ # @return [Bool] false
47
+ def rpc_invalid_token_error?
48
+ false
49
+ end
50
+
51
+ # @return [Bool] false
52
+ def rpc_exception?
53
+ false
54
+ end
55
+
56
+ end
57
+
58
+ module Arachni
59
+ module RPC
60
+ module Exceptions
61
+
62
+ #
63
+ # Returns an exception based on the response object.
64
+ #
65
+ # @param [Arachni::RPC::Response] response
66
+ #
67
+ # @return [Exception]
68
+ #
69
+ def self.from_response( response )
70
+ obj = response.obj
71
+ klass = Arachni::RPC::Exceptions.const_get( obj['type'].to_sym )
72
+ e = klass.new( obj['exception'] )
73
+ e.set_backtrace( obj['backtrace'] )
74
+ return e
75
+ end
76
+
77
+ class Base < ::Exception
78
+ #
79
+ # @return [Bool] true
80
+ #
81
+ def rpc_exception?
82
+ true
83
+ end
84
+ end
85
+
86
+ #
87
+ # Signifies an abruptly terminated connection.
88
+ #
89
+ # Look for network or SSL errors or a dead server or a mistyped server address/port.
90
+ #
91
+ class ConnectionError < Base
92
+
93
+ #
94
+ # @return [Bool] true
95
+ #
96
+ def rpc_connection_error?
97
+ true
98
+ end
99
+ end
100
+
101
+ #
102
+ # Signifies an exception that occurred on the server-side.
103
+ #
104
+ # Look errors on the remote method and review the server output for more details.
105
+ #
106
+ class RemoteException < Base
107
+
108
+ #
109
+ # @return [Bool] true
110
+ #
111
+ def rpc_remote_exception?
112
+ true
113
+ end
114
+ end
115
+
116
+ #
117
+ # An invalid object has been called.
118
+ #
119
+ # Make sure that there is a server-side handler for the object you called.
120
+ #
121
+ class InvalidObject < Base
122
+
123
+ #
124
+ # @return [Bool] true
125
+ #
126
+ def rpc_invalid_object_error?
127
+ true
128
+ end
129
+
130
+ end
131
+
132
+ #
133
+ # An invalid method has been called.
134
+ #
135
+ # Occurs when a remote method doesn't exist or isn't public.
136
+ #
137
+ class InvalidMethod < Base
138
+
139
+ #
140
+ # @return [Bool] true
141
+ #
142
+ def rpc_invalid_method_error?
143
+ true
144
+ end
145
+
146
+ end
147
+
148
+ #
149
+ # Signifies an authentication token mismatch between the client and the server.
150
+ #
151
+ class InvalidToken < Base
152
+
153
+ #
154
+ # @return [Bool] true
155
+ #
156
+ def rpc_invalid_token_error?
157
+ true
158
+ end
159
+
160
+ end
161
+
162
+ #
163
+ # Signifies an authentication token mismatch between the client and the server.
164
+ #
165
+ class SSLPeerVerificationFailed < ConnectionError
166
+
167
+ #
168
+ # @return [Bool] true
169
+ #
170
+ def rpc_ssl_error?
171
+ true
172
+ end
173
+
174
+ end
175
+
176
+ end
177
+ end
178
+ end
@@ -0,0 +1,87 @@
1
+ =begin
2
+ Arachni-RPC
3
+ Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
4
+
5
+ This is free software; you can copy and distribute and modify
6
+ this program under the term of the GPL v2.0 License
7
+ (See LICENSE file for details)
8
+
9
+ =end
10
+
11
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), '../', 'rpc' )
12
+
13
+ module Arachni
14
+ module RPC
15
+
16
+ #
17
+ # Represents an RPC message, serves as the basis for {Request} and {Response}.
18
+ #
19
+ # @author: Tasos "Zapotek" Laskos
20
+ # <tasos.laskos@gmail.com>
21
+ # <zapotek@segfault.gr>
22
+ # @version: 0.1
23
+ #
24
+ class Message
25
+
26
+ #
27
+ # @param [Hash] opts sets instance attributes
28
+ #
29
+ def initialize( opts = {} )
30
+ opts.each_pair {
31
+ |k, v|
32
+ instance_variable_set( "@#{k}".to_sym, v )
33
+ }
34
+ end
35
+
36
+ #
37
+ # Merges the attributes of another message with self.
38
+ #
39
+ # (The param doesn't *really* have to be a message, any object will do.)
40
+ #
41
+ # @param [Message] message
42
+ #
43
+ def merge!( message )
44
+ message.instance_variables.each {
45
+ |var|
46
+ val = message.instance_variable_get( var )
47
+ instance_variable_set( var, val )
48
+ }
49
+ end
50
+
51
+ #
52
+ # Prepares the message for transmission (i.e. converts the message to a Hash).
53
+ #
54
+ # Attributes that should not be included can be skipped by implementing
55
+ # {#transmit?} and returning the appropriate value.
56
+ #
57
+ # @return [Hash]
58
+ #
59
+ def prepare_for_tx
60
+ hash = {}
61
+ instance_variables.each {
62
+ |k|
63
+ next if !transmit?( k )
64
+ hash[normalize( k )] = instance_variable_get( k )
65
+ }
66
+ return hash
67
+ end
68
+
69
+ #
70
+ # Decides which attributes should be skipped by {#prepare_for_tx}.
71
+ #
72
+ # @param [Symbol] attr attribute symbol (i.e. :@token)
73
+ #
74
+ def transmit?( attr )
75
+ return true
76
+ end
77
+
78
+ private
79
+
80
+ def normalize( attr )
81
+ attr.to_s.gsub( '@', '' )
82
+ end
83
+
84
+ end
85
+
86
+ end
87
+ end
@@ -0,0 +1,70 @@
1
+ =begin
2
+ Arachni-RPC
3
+ Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
4
+
5
+ This is free software; you can copy and distribute and modify
6
+ this program under the term of the GPL v2.0 License
7
+ (See LICENSE file for details)
8
+
9
+ =end
10
+
11
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), '../', 'rpc' )
12
+
13
+ module Arachni
14
+ module RPC
15
+
16
+ #
17
+ # Maps the methods of remote objects to local ones.
18
+ # (Well, not really, it just passes the message along to the remote end.)
19
+ #
20
+ # You start like:
21
+ #
22
+ # server = Arachni::RPC::EM::Client.new( :host => 'localhost', :port => 7331 )
23
+ # bench = Arachni::RPC::EM::Client::Mapper.new( server, 'bench' )
24
+ #
25
+ # And it allows you to do this:
26
+ #
27
+ # res = bench.foo( 1, 2, 3 )
28
+ #
29
+ # Instead of:
30
+ #
31
+ # res = client.call( 'bench.foo', 1, 2, 3 )
32
+ #
33
+ #
34
+ #
35
+ # The server on the other end must have an appropriate handler set, like:
36
+ #
37
+ # class Bench
38
+ # def foo( i = 0 )
39
+ # return i
40
+ # end
41
+ # end
42
+ #
43
+ # server = Arachni::RPC::EM::Server.new( :host => 'localhost', :port => 7331 )
44
+ # server.add_handler( 'bench', Bench.new )
45
+ #
46
+ # @author: Tasos "Zapotek" Laskos
47
+ # <tasos.laskos@gmail.com>
48
+ # <zapotek@segfault.gr>
49
+ # @version: 0.1
50
+ #
51
+ class RemoteObjectMapper
52
+
53
+ def initialize( server, remote )
54
+ @server = server
55
+ @remote = remote
56
+ end
57
+
58
+ private
59
+ #
60
+ # Used to provide the illusion of locality for remote methods
61
+ #
62
+ def method_missing( sym, *args, &block )
63
+ call = "#{@remote}.#{sym.to_s}"
64
+ @server.call( call, *args, &block )
65
+ end
66
+
67
+ end
68
+
69
+ end
70
+ end
@@ -0,0 +1,95 @@
1
+ =begin
2
+ Arachni-RPC
3
+ Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
4
+
5
+ This is free software; you can copy and distribute and modify
6
+ this program under the term of the GPL v2.0 License
7
+ (See LICENSE file for details)
8
+
9
+ =end
10
+
11
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), '../', 'rpc' )
12
+
13
+ module Arachni
14
+ module RPC
15
+
16
+ #
17
+ # Represents an RPC request.
18
+ #
19
+ # It's here only for formalization purposes,
20
+ # it's not actually sent over the wire.
21
+ #
22
+ # What is sent is a hash generated by {#prepare_for_tx}.
23
+ # which is in the form of:
24
+ #
25
+ #
26
+ # {
27
+ # 'message' => msg, # RPC message in the form of 'handler.method'
28
+ # 'args' => args, # optional array of arguments for the remote method
29
+ # 'token' => token, # optional authentication token
30
+ # }
31
+ #
32
+ # Any client that has SSL support and can serialize a Hash
33
+ # just like the one above can communicate with the RPC server.
34
+ #
35
+ # @author: Tasos "Zapotek" Laskos
36
+ # <tasos.laskos@gmail.com>
37
+ # <zapotek@segfault.gr>
38
+ # @version: 0.1
39
+ #
40
+ class Request < Message
41
+
42
+ #
43
+ # RPC message in the form of 'handler.method'.
44
+ #
45
+ # @return [String]
46
+ #
47
+ attr_accessor :message
48
+
49
+ #
50
+ # Optional array of arguments for the remote method.
51
+ #
52
+ # @return [Array]
53
+ #
54
+ attr_accessor :args
55
+
56
+ #
57
+ # Optional authentication token.
58
+ #
59
+ # @return [String]
60
+ #
61
+ attr_accessor :token
62
+
63
+ #
64
+ # Callback to be invoked on the response.
65
+ #
66
+ # @return [Proc]
67
+ #
68
+ attr_accessor :callback
69
+
70
+ # @see Message#initialize
71
+ def initialize( * )
72
+ super
73
+ end
74
+
75
+ def do_not_defer!
76
+ @defer = false
77
+ end
78
+
79
+ def defer?
80
+ @defer.nil? ? true : @defer
81
+ end
82
+
83
+ private
84
+
85
+ def transmit?( attr )
86
+ ![
87
+ :@defer,
88
+ :@callback
89
+ ].include?( attr )
90
+ end
91
+
92
+ end
93
+
94
+ end
95
+ end
@@ -0,0 +1,86 @@
1
+ =begin
2
+ Arachni-RPC
3
+ Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
4
+
5
+ This is free software; you can copy and distribute and modify
6
+ this program under the term of the GPL v2.0 License
7
+ (See LICENSE file for details)
8
+
9
+ =end
10
+
11
+ require File.join( File.expand_path( File.dirname( __FILE__ ) ), '../', 'rpc' )
12
+
13
+ module Arachni
14
+ module RPC
15
+
16
+ #
17
+ # Represents an RPC response.
18
+ #
19
+ # It's here only for formalization purposes, it's not actually sent over the wire.
20
+ #
21
+ # What is sent is a hash generated by {#prepare_for_tx}
22
+ # which is in the form of:
23
+ #
24
+ #
25
+ # {
26
+ # # result of the RPC call
27
+ # 'obj' => object
28
+ # }
29
+ #
30
+ # @author: Tasos "Zapotek" Laskos
31
+ # <tasos.laskos@gmail.com>
32
+ # <zapotek@segfault.gr>
33
+ # @version: 0.1
34
+ #
35
+ class Response < Message
36
+
37
+ #
38
+ # Return object of the {Request#message}.
39
+ #
40
+ # If there was an exception it will hold a Hash like:
41
+ #
42
+ # {
43
+ # "exception" => "Trying to access non-existent object 'blah'.",
44
+ # "backtrace" => [
45
+ # [0] "/home/zapotek/workspace/arachni-rpc/lib/arachni/rpc/server.rb:285:in `call'",
46
+ # [1] "/home/zapotek/workspace/arachni-rpc/lib/arachni/rpc/server.rb:85:in `block in receive_object'",
47
+ # [2] "/home/zapotek/.rvm/gems/ruby-1.9.2-p180/gems/eventmachine-1.0.0.beta.3/lib/eventmachine.rb:1009:in `call'",
48
+ # [3] "/home/zapotek/.rvm/gems/ruby-1.9.2-p180/gems/eventmachine-1.0.0.beta.3/lib/eventmachine.rb:1009:in `block in spawn_threadpool'"
49
+ # ],
50
+ # "type" => "InvalidObject"
51
+ # }
52
+ #
53
+ # For all available exception types look at {Exceptions}.
54
+ #
55
+ # @return [Object]
56
+ #
57
+ attr_accessor :obj
58
+
59
+ # @see Message#initialize
60
+ def initialize( * )
61
+ super
62
+
63
+ @async = false
64
+ end
65
+
66
+ def async?
67
+ @async
68
+ end
69
+
70
+ def async!
71
+ @async = true
72
+ end
73
+
74
+ private
75
+
76
+ def transmit?( attr )
77
+ ![
78
+ :@async
79
+ ].include?( attr )
80
+ end
81
+
82
+
83
+ end
84
+
85
+ end
86
+ end
@@ -0,0 +1,15 @@
1
+ =begin
2
+ Arachni-RPC
3
+ Copyright (c) 2011 Tasos "Zapotek" Laskos <tasos.laskos@gmail.com>
4
+
5
+ This is free software; you can copy and distribute and modify
6
+ this program under the term of the GPL v2.0 License
7
+ (See LICENSE file for details)
8
+
9
+ =end
10
+
11
+ module Arachni
12
+ module RPC
13
+ VERSION = '0.1'
14
+ end
15
+ end
metadata ADDED
@@ -0,0 +1,61 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: arachni-rpc
3
+ version: !ruby/object:Gem::Version
4
+ version: '0.1'
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Tasos Laskos
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2011-12-14 00:00:00.000000000 Z
13
+ dependencies: []
14
+ description: ! " Arachni-RPC is a simple and lightweight Remote Procedure Call
15
+ protocol\n used to provide the basis for Arachni's Grid infrastructure.\n"
16
+ email: tasos.laskos@gmail.com
17
+ executables: []
18
+ extensions: []
19
+ extra_rdoc_files:
20
+ - README.md
21
+ - LICENSE.md
22
+ - CHANGELOG.md
23
+ files:
24
+ - README.md
25
+ - Rakefile
26
+ - LICENSE.md
27
+ - CHANGELOG.md
28
+ - lib/arachni/rpc/response.rb
29
+ - lib/arachni/rpc/version.rb
30
+ - lib/arachni/rpc/remote_object_mapper.rb
31
+ - lib/arachni/rpc/exceptions.rb
32
+ - lib/arachni/rpc/request.rb
33
+ - lib/arachni/rpc/message.rb
34
+ - lib/arachni/rpc.rb
35
+ homepage: https://github.com/Arachni/arachni-rpc
36
+ licenses: []
37
+ post_install_message:
38
+ rdoc_options:
39
+ - --charset=UTF-8
40
+ require_paths:
41
+ - lib
42
+ required_ruby_version: !ruby/object:Gem::Requirement
43
+ none: false
44
+ requirements:
45
+ - - ! '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ required_rubygems_version: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ! '>='
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ requirements: []
55
+ rubyforge_project:
56
+ rubygems_version: 1.8.10
57
+ signing_key:
58
+ specification_version: 3
59
+ summary: The RPC protocol specification of the Arachni WebAppSec scanner Grid.
60
+ test_files: []
61
+ has_rdoc: