cfmx_compat 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,2 @@
1
+ source "https://rubygems.org"
2
+ gemspec
@@ -0,0 +1,504 @@
1
+
2
+ GNU LESSER GENERAL PUBLIC LICENSE
3
+ Version 2.1, February 1999
4
+
5
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
6
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
7
+ Everyone is permitted to copy and distribute verbatim copies
8
+ of this license document, but changing it is not allowed.
9
+
10
+ (This is the first released version of the Lesser GPL. It also counts
11
+ as the successor of the GNU Library Public License, version 2, hence
12
+ the version number 2.1.)
13
+
14
+ Preamble
15
+
16
+ The licenses for most software are designed to take away your
17
+ freedom to share and change it. By contrast, the GNU General Public
18
+ Licenses are intended to guarantee your freedom to share and change
19
+ free software--to make sure the software is free for all its users.
20
+
21
+ This license, the Lesser General Public License, applies to some
22
+ specially designated software packages--typically libraries--of the
23
+ Free Software Foundation and other authors who decide to use it. You
24
+ can use it too, but we suggest you first think carefully about whether
25
+ this license or the ordinary General Public License is the better
26
+ strategy to use in any particular case, based on the explanations below.
27
+
28
+ When we speak of free software, we are referring to freedom of use,
29
+ not price. Our General Public Licenses are designed to make sure that
30
+ you have the freedom to distribute copies of free software (and charge
31
+ for this service if you wish); that you receive source code or can get
32
+ it if you want it; that you can change the software and use pieces of
33
+ it in new free programs; and that you are informed that you can do
34
+ these things.
35
+
36
+ To protect your rights, we need to make restrictions that forbid
37
+ distributors to deny you these rights or to ask you to surrender these
38
+ rights. These restrictions translate to certain responsibilities for
39
+ you if you distribute copies of the library or if you modify it.
40
+
41
+ For example, if you distribute copies of the library, whether gratis
42
+ or for a fee, you must give the recipients all the rights that we gave
43
+ you. You must make sure that they, too, receive or can get the source
44
+ code. If you link other code with the library, you must provide
45
+ complete object files to the recipients, so that they can relink them
46
+ with the library after making changes to the library and recompiling
47
+ it. And you must show them these terms so they know their rights.
48
+
49
+ We protect your rights with a two-step method: (1) we copyright the
50
+ library, and (2) we offer you this license, which gives you legal
51
+ permission to copy, distribute and/or modify the library.
52
+
53
+ To protect each distributor, we want to make it very clear that
54
+ there is no warranty for the free library. Also, if the library is
55
+ modified by someone else and passed on, the recipients should know
56
+ that what they have is not the original version, so that the original
57
+ author's reputation will not be affected by problems that might be
58
+ introduced by others.
59
+
60
+ Finally, software patents pose a constant threat to the existence of
61
+ any free program. We wish to make sure that a company cannot
62
+ effectively restrict the users of a free program by obtaining a
63
+ restrictive license from a patent holder. Therefore, we insist that
64
+ any patent license obtained for a version of the library must be
65
+ consistent with the full freedom of use specified in this license.
66
+
67
+ Most GNU software, including some libraries, is covered by the
68
+ ordinary GNU General Public License. This license, the GNU Lesser
69
+ General Public License, applies to certain designated libraries, and
70
+ is quite different from the ordinary General Public License. We use
71
+ this license for certain libraries in order to permit linking those
72
+ libraries into non-free programs.
73
+
74
+ When a program is linked with a library, whether statically or using
75
+ a shared library, the combination of the two is legally speaking a
76
+ combined work, a derivative of the original library. The ordinary
77
+ General Public License therefore permits such linking only if the
78
+ entire combination fits its criteria of freedom. The Lesser General
79
+ Public License permits more lax criteria for linking other code with
80
+ the library.
81
+
82
+ We call this license the "Lesser" General Public License because it
83
+ does Less to protect the user's freedom than the ordinary General
84
+ Public License. It also provides other free software developers Less
85
+ of an advantage over competing non-free programs. These disadvantages
86
+ are the reason we use the ordinary General Public License for many
87
+ libraries. However, the Lesser license provides advantages in certain
88
+ special circumstances.
89
+
90
+ For example, on rare occasions, there may be a special need to
91
+ encourage the widest possible use of a certain library, so that it becomes
92
+ a de-facto standard. To achieve this, non-free programs must be
93
+ allowed to use the library. A more frequent case is that a free
94
+ library does the same job as widely used non-free libraries. In this
95
+ case, there is little to gain by limiting the free library to free
96
+ software only, so we use the Lesser General Public License.
97
+
98
+ In other cases, permission to use a particular library in non-free
99
+ programs enables a greater number of people to use a large body of
100
+ free software. For example, permission to use the GNU C Library in
101
+ non-free programs enables many more people to use the whole GNU
102
+ operating system, as well as its variant, the GNU/Linux operating
103
+ system.
104
+
105
+ Although the Lesser General Public License is Less protective of the
106
+ users' freedom, it does ensure that the user of a program that is
107
+ linked with the Library has the freedom and the wherewithal to run
108
+ that program using a modified version of the Library.
109
+
110
+ The precise terms and conditions for copying, distribution and
111
+ modification follow. Pay close attention to the difference between a
112
+ "work based on the library" and a "work that uses the library". The
113
+ former contains code derived from the library, whereas the latter must
114
+ be combined with the library in order to run.
115
+
116
+ GNU LESSER GENERAL PUBLIC LICENSE
117
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
118
+
119
+ 0. This License Agreement applies to any software library or other
120
+ program which contains a notice placed by the copyright holder or
121
+ other authorized party saying it may be distributed under the terms of
122
+ this Lesser General Public License (also called "this License").
123
+ Each licensee is addressed as "you".
124
+
125
+ A "library" means a collection of software functions and/or data
126
+ prepared so as to be conveniently linked with application programs
127
+ (which use some of those functions and data) to form executables.
128
+
129
+ The "Library", below, refers to any such software library or work
130
+ which has been distributed under these terms. A "work based on the
131
+ Library" means either the Library or any derivative work under
132
+ copyright law: that is to say, a work containing the Library or a
133
+ portion of it, either verbatim or with modifications and/or translated
134
+ straightforwardly into another language. (Hereinafter, translation is
135
+ included without limitation in the term "modification".)
136
+
137
+ "Source code" for a work means the preferred form of the work for
138
+ making modifications to it. For a library, complete source code means
139
+ all the source code for all modules it contains, plus any associated
140
+ interface definition files, plus the scripts used to control compilation
141
+ and installation of the library.
142
+
143
+ Activities other than copying, distribution and modification are not
144
+ covered by this License; they are outside its scope. The act of
145
+ running a program using the Library is not restricted, and output from
146
+ such a program is covered only if its contents constitute a work based
147
+ on the Library (independent of the use of the Library in a tool for
148
+ writing it). Whether that is true depends on what the Library does
149
+ and what the program that uses the Library does.
150
+
151
+ 1. You may copy and distribute verbatim copies of the Library's
152
+ complete source code as you receive it, in any medium, provided that
153
+ you conspicuously and appropriately publish on each copy an
154
+ appropriate copyright notice and disclaimer of warranty; keep intact
155
+ all the notices that refer to this License and to the absence of any
156
+ warranty; and distribute a copy of this License along with the
157
+ Library.
158
+
159
+ You may charge a fee for the physical act of transferring a copy,
160
+ and you may at your option offer warranty protection in exchange for a
161
+ fee.
162
+
163
+ 2. You may modify your copy or copies of the Library or any portion
164
+ of it, thus forming a work based on the Library, and copy and
165
+ distribute such modifications or work under the terms of Section 1
166
+ above, provided that you also meet all of these conditions:
167
+
168
+ a) The modified work must itself be a software library.
169
+
170
+ b) You must cause the files modified to carry prominent notices
171
+ stating that you changed the files and the date of any change.
172
+
173
+ c) You must cause the whole of the work to be licensed at no
174
+ charge to all third parties under the terms of this License.
175
+
176
+ d) If a facility in the modified Library refers to a function or a
177
+ table of data to be supplied by an application program that uses
178
+ the facility, other than as an argument passed when the facility
179
+ is invoked, then you must make a good faith effort to ensure that,
180
+ in the event an application does not supply such function or
181
+ table, the facility still operates, and performs whatever part of
182
+ its purpose remains meaningful.
183
+
184
+ (For example, a function in a library to compute square roots has
185
+ a purpose that is entirely well-defined independent of the
186
+ application. Therefore, Subsection 2d requires that any
187
+ application-supplied function or table used by this function must
188
+ be optional: if the application does not supply it, the square
189
+ root function must still compute square roots.)
190
+
191
+ These requirements apply to the modified work as a whole. If
192
+ identifiable sections of that work are not derived from the Library,
193
+ and can be reasonably considered independent and separate works in
194
+ themselves, then this License, and its terms, do not apply to those
195
+ sections when you distribute them as separate works. But when you
196
+ distribute the same sections as part of a whole which is a work based
197
+ on the Library, the distribution of the whole must be on the terms of
198
+ this License, whose permissions for other licensees extend to the
199
+ entire whole, and thus to each and every part regardless of who wrote
200
+ it.
201
+
202
+ Thus, it is not the intent of this section to claim rights or contest
203
+ your rights to work written entirely by you; rather, the intent is to
204
+ exercise the right to control the distribution of derivative or
205
+ collective works based on the Library.
206
+
207
+ In addition, mere aggregation of another work not based on the Library
208
+ with the Library (or with a work based on the Library) on a volume of
209
+ a storage or distribution medium does not bring the other work under
210
+ the scope of this License.
211
+
212
+ 3. You may opt to apply the terms of the ordinary GNU General Public
213
+ License instead of this License to a given copy of the Library. To do
214
+ this, you must alter all the notices that refer to this License, so
215
+ that they refer to the ordinary GNU General Public License, version 2,
216
+ instead of to this License. (If a newer version than version 2 of the
217
+ ordinary GNU General Public License has appeared, then you can specify
218
+ that version instead if you wish.) Do not make any other change in
219
+ these notices.
220
+
221
+ Once this change is made in a given copy, it is irreversible for
222
+ that copy, so the ordinary GNU General Public License applies to all
223
+ subsequent copies and derivative works made from that copy.
224
+
225
+ This option is useful when you wish to copy part of the code of
226
+ the Library into a program that is not a library.
227
+
228
+ 4. You may copy and distribute the Library (or a portion or
229
+ derivative of it, under Section 2) in object code or executable form
230
+ under the terms of Sections 1 and 2 above provided that you accompany
231
+ it with the complete corresponding machine-readable source code, which
232
+ must be distributed under the terms of Sections 1 and 2 above on a
233
+ medium customarily used for software interchange.
234
+
235
+ If distribution of object code is made by offering access to copy
236
+ from a designated place, then offering equivalent access to copy the
237
+ source code from the same place satisfies the requirement to
238
+ distribute the source code, even though third parties are not
239
+ compelled to copy the source along with the object code.
240
+
241
+ 5. A program that contains no derivative of any portion of the
242
+ Library, but is designed to work with the Library by being compiled or
243
+ linked with it, is called a "work that uses the Library". Such a
244
+ work, in isolation, is not a derivative work of the Library, and
245
+ therefore falls outside the scope of this License.
246
+
247
+ However, linking a "work that uses the Library" with the Library
248
+ creates an executable that is a derivative of the Library (because it
249
+ contains portions of the Library), rather than a "work that uses the
250
+ library". The executable is therefore covered by this License.
251
+ Section 6 states terms for distribution of such executables.
252
+
253
+ When a "work that uses the Library" uses material from a header file
254
+ that is part of the Library, the object code for the work may be a
255
+ derivative work of the Library even though the source code is not.
256
+ Whether this is true is especially significant if the work can be
257
+ linked without the Library, or if the work is itself a library. The
258
+ threshold for this to be true is not precisely defined by law.
259
+
260
+ If such an object file uses only numerical parameters, data
261
+ structure layouts and accessors, and small macros and small inline
262
+ functions (ten lines or less in length), then the use of the object
263
+ file is unrestricted, regardless of whether it is legally a derivative
264
+ work. (Executables containing this object code plus portions of the
265
+ Library will still fall under Section 6.)
266
+
267
+ Otherwise, if the work is a derivative of the Library, you may
268
+ distribute the object code for the work under the terms of Section 6.
269
+ Any executables containing that work also fall under Section 6,
270
+ whether or not they are linked directly with the Library itself.
271
+
272
+ 6. As an exception to the Sections above, you may also combine or
273
+ link a "work that uses the Library" with the Library to produce a
274
+ work containing portions of the Library, and distribute that work
275
+ under terms of your choice, provided that the terms permit
276
+ modification of the work for the customer's own use and reverse
277
+ engineering for debugging such modifications.
278
+
279
+ You must give prominent notice with each copy of the work that the
280
+ Library is used in it and that the Library and its use are covered by
281
+ this License. You must supply a copy of this License. If the work
282
+ during execution displays copyright notices, you must include the
283
+ copyright notice for the Library among them, as well as a reference
284
+ directing the user to the copy of this License. Also, you must do one
285
+ of these things:
286
+
287
+ a) Accompany the work with the complete corresponding
288
+ machine-readable source code for the Library including whatever
289
+ changes were used in the work (which must be distributed under
290
+ Sections 1 and 2 above); and, if the work is an executable linked
291
+ with the Library, with the complete machine-readable "work that
292
+ uses the Library", as object code and/or source code, so that the
293
+ user can modify the Library and then relink to produce a modified
294
+ executable containing the modified Library. (It is understood
295
+ that the user who changes the contents of definitions files in the
296
+ Library will not necessarily be able to recompile the application
297
+ to use the modified definitions.)
298
+
299
+ b) Use a suitable shared library mechanism for linking with the
300
+ Library. A suitable mechanism is one that (1) uses at run time a
301
+ copy of the library already present on the user's computer system,
302
+ rather than copying library functions into the executable, and (2)
303
+ will operate properly with a modified version of the library, if
304
+ the user installs one, as long as the modified version is
305
+ interface-compatible with the version that the work was made with.
306
+
307
+ c) Accompany the work with a written offer, valid for at
308
+ least three years, to give the same user the materials
309
+ specified in Subsection 6a, above, for a charge no more
310
+ than the cost of performing this distribution.
311
+
312
+ d) If distribution of the work is made by offering access to copy
313
+ from a designated place, offer equivalent access to copy the above
314
+ specified materials from the same place.
315
+
316
+ e) Verify that the user has already received a copy of these
317
+ materials or that you have already sent this user a copy.
318
+
319
+ For an executable, the required form of the "work that uses the
320
+ Library" must include any data and utility programs needed for
321
+ reproducing the executable from it. However, as a special exception,
322
+ the materials to be distributed need not include anything that is
323
+ normally distributed (in either source or binary form) with the major
324
+ components (compiler, kernel, and so on) of the operating system on
325
+ which the executable runs, unless that component itself accompanies
326
+ the executable.
327
+
328
+ It may happen that this requirement contradicts the license
329
+ restrictions of other proprietary libraries that do not normally
330
+ accompany the operating system. Such a contradiction means you cannot
331
+ use both them and the Library together in an executable that you
332
+ distribute.
333
+
334
+ 7. You may place library facilities that are a work based on the
335
+ Library side-by-side in a single library together with other library
336
+ facilities not covered by this License, and distribute such a combined
337
+ library, provided that the separate distribution of the work based on
338
+ the Library and of the other library facilities is otherwise
339
+ permitted, and provided that you do these two things:
340
+
341
+ a) Accompany the combined library with a copy of the same work
342
+ based on the Library, uncombined with any other library
343
+ facilities. This must be distributed under the terms of the
344
+ Sections above.
345
+
346
+ b) Give prominent notice with the combined library of the fact
347
+ that part of it is a work based on the Library, and explaining
348
+ where to find the accompanying uncombined form of the same work.
349
+
350
+ 8. You may not copy, modify, sublicense, link with, or distribute
351
+ the Library except as expressly provided under this License. Any
352
+ attempt otherwise to copy, modify, sublicense, link with, or
353
+ distribute the Library is void, and will automatically terminate your
354
+ rights under this License. However, parties who have received copies,
355
+ or rights, from you under this License will not have their licenses
356
+ terminated so long as such parties remain in full compliance.
357
+
358
+ 9. You are not required to accept this License, since you have not
359
+ signed it. However, nothing else grants you permission to modify or
360
+ distribute the Library or its derivative works. These actions are
361
+ prohibited by law if you do not accept this License. Therefore, by
362
+ modifying or distributing the Library (or any work based on the
363
+ Library), you indicate your acceptance of this License to do so, and
364
+ all its terms and conditions for copying, distributing or modifying
365
+ the Library or works based on it.
366
+
367
+ 10. Each time you redistribute the Library (or any work based on the
368
+ Library), the recipient automatically receives a license from the
369
+ original licensor to copy, distribute, link with or modify the Library
370
+ subject to these terms and conditions. You may not impose any further
371
+ restrictions on the recipients' exercise of the rights granted herein.
372
+ You are not responsible for enforcing compliance by third parties with
373
+ this License.
374
+
375
+ 11. If, as a consequence of a court judgment or allegation of patent
376
+ infringement or for any other reason (not limited to patent issues),
377
+ conditions are imposed on you (whether by court order, agreement or
378
+ otherwise) that contradict the conditions of this License, they do not
379
+ excuse you from the conditions of this License. If you cannot
380
+ distribute so as to satisfy simultaneously your obligations under this
381
+ License and any other pertinent obligations, then as a consequence you
382
+ may not distribute the Library at all. For example, if a patent
383
+ license would not permit royalty-free redistribution of the Library by
384
+ all those who receive copies directly or indirectly through you, then
385
+ the only way you could satisfy both it and this License would be to
386
+ refrain entirely from distribution of the Library.
387
+
388
+ If any portion of this section is held invalid or unenforceable under any
389
+ particular circumstance, the balance of the section is intended to apply,
390
+ and the section as a whole is intended to apply in other circumstances.
391
+
392
+ It is not the purpose of this section to induce you to infringe any
393
+ patents or other property right claims or to contest validity of any
394
+ such claims; this section has the sole purpose of protecting the
395
+ integrity of the free software distribution system which is
396
+ implemented by public license practices. Many people have made
397
+ generous contributions to the wide range of software distributed
398
+ through that system in reliance on consistent application of that
399
+ system; it is up to the author/donor to decide if he or she is willing
400
+ to distribute software through any other system and a licensee cannot
401
+ impose that choice.
402
+
403
+ This section is intended to make thoroughly clear what is believed to
404
+ be a consequence of the rest of this License.
405
+
406
+ 12. If the distribution and/or use of the Library is restricted in
407
+ certain countries either by patents or by copyrighted interfaces, the
408
+ original copyright holder who places the Library under this License may add
409
+ an explicit geographical distribution limitation excluding those countries,
410
+ so that distribution is permitted only in or among countries not thus
411
+ excluded. In such case, this License incorporates the limitation as if
412
+ written in the body of this License.
413
+
414
+ 13. The Free Software Foundation may publish revised and/or new
415
+ versions of the Lesser General Public License from time to time.
416
+ Such new versions will be similar in spirit to the present version,
417
+ but may differ in detail to address new problems or concerns.
418
+
419
+ Each version is given a distinguishing version number. If the Library
420
+ specifies a version number of this License which applies to it and
421
+ "any later version", you have the option of following the terms and
422
+ conditions either of that version or of any later version published by
423
+ the Free Software Foundation. If the Library does not specify a
424
+ license version number, you may choose any version ever published by
425
+ the Free Software Foundation.
426
+
427
+ 14. If you wish to incorporate parts of the Library into other free
428
+ programs whose distribution conditions are incompatible with these,
429
+ write to the author to ask for permission. For software which is
430
+ copyrighted by the Free Software Foundation, write to the Free
431
+ Software Foundation; we sometimes make exceptions for this. Our
432
+ decision will be guided by the two goals of preserving the free status
433
+ of all derivatives of our free software and of promoting the sharing
434
+ and reuse of software generally.
435
+
436
+ NO WARRANTY
437
+
438
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
439
+ WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
440
+ EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
441
+ OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
442
+ KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
443
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
444
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
445
+ LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
446
+ THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
447
+
448
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
449
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
450
+ AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
451
+ FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
452
+ CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
453
+ LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
454
+ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
455
+ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
456
+ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
457
+ DAMAGES.
458
+
459
+ END OF TERMS AND CONDITIONS
460
+
461
+ How to Apply These Terms to Your New Libraries
462
+
463
+ If you develop a new library, and you want it to be of the greatest
464
+ possible use to the public, we recommend making it free software that
465
+ everyone can redistribute and change. You can do so by permitting
466
+ redistribution under these terms (or, alternatively, under the terms of the
467
+ ordinary General Public License).
468
+
469
+ To apply these terms, attach the following notices to the library. It is
470
+ safest to attach them to the start of each source file to most effectively
471
+ convey the exclusion of warranty; and each file should have at least the
472
+ "copyright" line and a pointer to where the full notice is found.
473
+
474
+ {description}
475
+ Copyright (C) {year} {fullname}
476
+
477
+ This library is free software; you can redistribute it and/or
478
+ modify it under the terms of the GNU Lesser General Public
479
+ License as published by the Free Software Foundation; either
480
+ version 2.1 of the License, or (at your option) any later version.
481
+
482
+ This library is distributed in the hope that it will be useful,
483
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
484
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
485
+ Lesser General Public License for more details.
486
+
487
+ You should have received a copy of the GNU Lesser General Public
488
+ License along with this library; if not, write to the Free Software
489
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
490
+
491
+ Also add information on how to contact you by electronic and paper mail.
492
+
493
+ You should also get your employer (if you work as a programmer) or your
494
+ school, if any, to sign a "copyright disclaimer" for the library, if
495
+ necessary. Here is a sample; alter the names:
496
+
497
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
498
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
499
+
500
+ {signature of Ty Coon}, 1 April 1990
501
+ Ty Coon, President of Vice
502
+
503
+ That's all there is to it!
504
+
@@ -0,0 +1,92 @@
1
+ # CFMX_COMPAT
2
+
3
+ Ruby implementation of the CFMX_COMPAT algorithm within ColdFusion. This will allow you to encrypt and decrypt strings using the CFMX_COMPAT algorithm.
4
+
5
+ The ColdFusion `encrypt()` and `decrypt()` functions also encode the result after encryption and automatically decode before decryption. This gem applies the same encoding and decoding behaviours as ColdFusion.
6
+
7
+ - Base64: the Base64 algorithm, as specified by IETF RFC 2045.
8
+ - Hex: the characters A-F0-9 represent the hexadecimal byte values.
9
+ - UU: the UUEncode algorithm (DEFAULT).
10
+
11
+ The Ruby implementation here is translated from one [found](https://github.com/getrailo/railo/blob/f0da69a7ad62fe760e40d9cd880bdecfd38a51d7/railo-java/railo-core/src/railo/runtime/crypt/CFMXCompat.java) in Railo and a [C# implementation](http://stackoverflow.com/a/4627069) of that.
12
+
13
+ ## Installation
14
+
15
+ Add this line to your application's Gemfile:
16
+
17
+ gem 'cfmx_compat'
18
+
19
+ And then execute:
20
+
21
+ $ bundle
22
+
23
+ Or install it yourself as:
24
+
25
+ $ gem install cfmx_compat
26
+
27
+ ## Usage
28
+
29
+ In Ruby, using this gem:
30
+
31
+ ```
32
+ key = "secretkey"
33
+ plain = "plain text value"
34
+
35
+ encrypted = CfmxCompat.encrypt(plain, key)
36
+ decrypted = CfmxCompat.decrypt(encrypted, key)
37
+ plain == decrypted # true
38
+
39
+ encrypted = CfmxCompat.encrypt(plain, key, "uu")
40
+ decrypted = CfmxCompat.decrypt(encrypted, key, "uu")
41
+ plain == decrypted # true
42
+
43
+ encrypted = CfmxCompat.encrypt(plain, key, "hex")
44
+ decrypted = CfmxCompat.decrypt(encrypted, key, "hex")
45
+ plain == decrypted # true
46
+
47
+ encrypted = CfmxCompat.encrypt(plain, key, "base64")
48
+ decrypted = CfmxCompat.decrypt(encrypted, key, "base64")
49
+ plain == decrypted # true
50
+ ```
51
+
52
+ Is the same as this in ColdFusion:
53
+
54
+ ```
55
+ <cfscript>
56
+ key = "secretkey";
57
+ plain = "plain text value";
58
+
59
+ encrypted = encrypt(plain, key);
60
+ decrypted = decrypt(encrypted, key);
61
+ decrypted == plain; # true
62
+
63
+ encrypted = encrypt(plain, key, "CFMX_COMPAT", "uu");
64
+ decrypted = decrypt(encrypted, key, "CFMX_COMPAT", "uu");
65
+ decrypted == plain; # true
66
+
67
+ encrypted = encrypt(plain, key, "CFMX_COMPAT", "hex");
68
+ decrypted = decrypt(encrypted, key, "CFMX_COMPAT", "hex");
69
+ decrypted == plain; # true
70
+
71
+ encrypted = encrypt(plain, key, "CFMX_COMPAT", "base64");
72
+ decrypted = decrypt(encrypted, key, "CFMX_COMPAT", "base64");
73
+ decrypted == plain; # true
74
+ </cfscript>
75
+ ```
76
+
77
+ ## Contributing
78
+
79
+ 1. Fork it
80
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
81
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
82
+ 4. Push to the branch (`git push origin my-new-feature`)
83
+ 5. Create new Pull Request
84
+
85
+ ## License
86
+
87
+ Copyright © 2013 Global Personals Ltd.
88
+
89
+ This library is released under the LGPL license as detailed in the LICENSE.txt file that should be distributed with this library; the source code is [freely available](http://github.com/globaldev/cfmx_compat).
90
+
91
+ [Global Personals Ltd](http://www.globalpersonals.co.uk/) have kindly agreed to the release of this software under the license terms above.
92
+
@@ -0,0 +1,8 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ task :default => :spec
4
+
5
+ require "rspec/core/rake_task"
6
+ RSpec::Core::RakeTask.new(:spec) do |spec|
7
+ spec.pattern = "spec/**/*_spec.rb"
8
+ end
@@ -0,0 +1,24 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'cfmx_compat/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "cfmx_compat"
8
+ spec.version = CfmxCompat::Version
9
+ spec.authors = ["Jason Lambert"]
10
+ spec.email = ["jlambert@globalpersonals.co.uk"]
11
+ spec.description = %q{A Ruby encryption library compatible with the CFMX_COMPAT standard used in ColdFusion}
12
+ spec.summary = %q{A Ruby encryption library compatible with the CFMX_COMPAT standard used in ColdFusion}
13
+ spec.homepage = "https://github.com/globaldev/cfmx_compat"
14
+ spec.license = "LGPL"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.3"
22
+ spec.add_development_dependency "rake"
23
+ spec.add_development_dependency "rspec"
24
+ end
@@ -0,0 +1,123 @@
1
+ require "base64"
2
+
3
+ class CfmxCompat
4
+ attr_accessor :m_LFSR_A, :m_LFSR_B, :m_LFSR_C
5
+ private :m_LFSR_A, :m_LFSR_B, :m_LFSR_C
6
+ private :m_LFSR_A=, :m_LFSR_B=, :m_LFSR_C=
7
+
8
+ M_MASK_A = 0x80000062
9
+ M_MASK_B = 0x40000020
10
+ M_MASK_C = 0x10000002
11
+ M_ROT0_A = 0x7fffffff
12
+ M_ROT0_B = 0x3fffffff
13
+ M_ROT0_C = 0xfffffff
14
+ M_ROT1_A = 0x80000000
15
+ M_ROT1_B = 0xc0000000
16
+ M_ROT1_C = 0xf0000000
17
+
18
+ UNSIGNED_CHAR = "C*"
19
+ UU_ENCODED_STRING = "u"
20
+ HEX_ENCODED_STRING = "H*"
21
+
22
+ def self.encrypt(string, key, encoding = "uu")
23
+ new.encrypt(string, key, encoding)
24
+ end
25
+
26
+ def self.decrypt(encoded, key, encoding = "uu")
27
+ new.decrypt(encoded, key, encoding)
28
+ end
29
+
30
+ def encrypt(string, key, encoding = "uu")
31
+ encode(transform_string(string || "", key), encoding)
32
+ end
33
+
34
+ def decrypt(encoded, key, encoding = "uu")
35
+ transform_string(decode(encoded || "", encoding), key)
36
+ end
37
+
38
+ private
39
+
40
+ def encode(result, encoding)
41
+ case encoding.downcase.to_s
42
+ when "uu" then
43
+ [result].pack(UU_ENCODED_STRING)
44
+ when "hex" then
45
+ result.unpack(HEX_ENCODED_STRING).first.upcase
46
+ when "base64"
47
+ Base64.strict_encode64(result) # strict = no new line to match CF.
48
+ else
49
+ raise ArgumentError, "Invalid CfmxCompat encoding option: '#{encoding}' (Expected UU, HEX, or BASE64)"
50
+ end
51
+ end
52
+
53
+ def decode(encoded, encoding)
54
+ case encoding.downcase.to_s
55
+ when "uu" then
56
+ encoded.unpack(UU_ENCODED_STRING).first
57
+ when "hex" then
58
+ encoded.scan(/../).map {|x| x.hex.chr }.join
59
+ when "base64" then
60
+ Base64.decode64(encoded)
61
+ else
62
+ raise ArgumentError, "Invalid CfmxCompat decoding option: '#{encoding}' (Expected UU, HEX, or BASE64)"
63
+ end
64
+ end
65
+
66
+ def transform_string(string, key)
67
+ raise ArgumentError, "CfmxCompat a key must be specified for encryption or decryption" unless key && key.length > 0
68
+ return "" unless string && string.length > 0
69
+
70
+ self.m_LFSR_A = 0x13579bdf
71
+ self.m_LFSR_B = 0x2468ace0
72
+ self.m_LFSR_C = 0xfdb97531
73
+ seed_from_key(key)
74
+
75
+ string.bytes.map {|byte| transform_byte(byte) }.pack(UNSIGNED_CHAR)
76
+ end
77
+
78
+ def transform_byte(target)
79
+ crypto = 0
80
+ b = m_LFSR_B & 1
81
+ c = m_LFSR_C & 1
82
+
83
+ 8.times do
84
+ if m_LFSR_A & 1 != 0
85
+ self.m_LFSR_A = m_LFSR_A ^ M_MASK_A >> 1 | M_ROT1_A
86
+
87
+ if m_LFSR_B & 1 != 0
88
+ self.m_LFSR_B = m_LFSR_B ^ M_MASK_B >> 1 | M_ROT1_B
89
+ b = 1
90
+ else
91
+ self.m_LFSR_B = m_LFSR_B >> 1 & M_ROT0_B
92
+ b = 0
93
+ end
94
+ else
95
+ self.m_LFSR_A = m_LFSR_A >> 1 & M_ROT0_A
96
+ if m_LFSR_C & 1 != 0
97
+ self.m_LFSR_C = m_LFSR_C ^ M_MASK_C >> 1 | M_ROT1_C
98
+ c = 1
99
+ else
100
+ self.m_LFSR_C = m_LFSR_C >> 1 & M_ROT0_C
101
+ c = 0
102
+ end
103
+ end
104
+ crypto = crypto << 1 | b ^ c
105
+ end
106
+ target ^= crypto
107
+ end
108
+
109
+ def seed_from_key(key)
110
+ doublekey = (key * 2).bytes.to_a
111
+ seed = Array.new(12) {|i| doublekey[i] || 0 }
112
+
113
+ 4.times do |i|
114
+ self.m_LFSR_A = (m_LFSR_A << 8) | seed[i+4]
115
+ self.m_LFSR_B = (m_LFSR_B << 8) | seed[i+4]
116
+ self.m_LFSR_C = (m_LFSR_C << 8) | seed[i+4]
117
+ end
118
+
119
+ self.m_LFSR_A = 0x13579bdf if m_LFSR_A == 0
120
+ self.m_LFSR_B = 0x2468ace0 if m_LFSR_B == 0
121
+ self.m_LFSR_C = 0xfdb97531 if m_LFSR_C == 0
122
+ end
123
+ end
@@ -0,0 +1,14 @@
1
+ class CfmxCompat
2
+ class Version
3
+ MAJOR = 0
4
+ MINOR = 0
5
+ PATCH = 1
6
+ PRE = nil
7
+
8
+ class << self
9
+ def to_s
10
+ [MAJOR, MINOR, PATCH, PRE].compact.join(".")
11
+ end
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,86 @@
1
+ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
2
+
3
+ describe CfmxCompat do
4
+ let(:key) { "mySecretKey" }
5
+ let(:plain) { "clear text" }
6
+
7
+ describe ".encrypt" do
8
+ context "nil string value" do
9
+ it "returns empty string" do
10
+ expect(CfmxCompat.encrypt(nil, key)).to eq ""
11
+ end
12
+ end
13
+
14
+ context "nil key value" do
15
+ it "raises ArgumentError" do
16
+ expect { CfmxCompat.encrypt(plain, nil) }.to raise_error(ArgumentError)
17
+ end
18
+ end
19
+
20
+ context "encoding" do
21
+ context "when not specified" do
22
+ it "encrypts correctly" do
23
+ expect(CfmxCompat.encrypt(plain, key)).to eq "*<@>J&XG+`99/40``\n"
24
+ end
25
+ end
26
+
27
+ context "when uu" do
28
+ it "encrypts correctly" do
29
+ expect(CfmxCompat.encrypt(plain, key, "uu")).to eq "*<@>J&XG+`99/40``\n"
30
+ end
31
+ end
32
+
33
+ context "when hex" do
34
+ it "encrypts correctly" do
35
+ expect(CfmxCompat.encrypt(plain, key, "hex")).to eq "7207AA1B89CB01964F51"
36
+ end
37
+ end
38
+
39
+ context "when base64" do
40
+ it "encrypts correctly" do
41
+ expect(CfmxCompat.encrypt(plain, key, "base64")).to eq "cgeqG4nLAZZPUQ=="
42
+ end
43
+ end
44
+ end
45
+ end
46
+
47
+ describe ".decrypt" do
48
+ context "nil string value" do
49
+ it "returns empty string" do
50
+ expect(CfmxCompat.decrypt(nil, key)).to eq ""
51
+ end
52
+ end
53
+
54
+ context "nil key value" do
55
+ it "raises ArgumentError" do
56
+ expect { CfmxCompat.decrypt(plain, nil) }.to raise_error(ArgumentError)
57
+ end
58
+ end
59
+
60
+ context "encoding" do
61
+ context "when not specified" do
62
+ it "decrypts correctly" do
63
+ expect(CfmxCompat.decrypt(CfmxCompat.encrypt(plain, key), key)).to eq plain
64
+ end
65
+ end
66
+
67
+ context "when uu" do
68
+ it "decrypts correctly" do
69
+ expect(CfmxCompat.decrypt(CfmxCompat.encrypt(plain, key, :uu), key, :uu)).to eq plain
70
+ end
71
+ end
72
+
73
+ context "when hex" do
74
+ it "decrypts correctly" do
75
+ expect(CfmxCompat.decrypt(CfmxCompat.encrypt(plain, key, :hex), key, :hex)).to eq plain
76
+ end
77
+ end
78
+
79
+ context "when base64" do
80
+ it "decrypts correctly" do
81
+ expect(CfmxCompat.decrypt(CfmxCompat.encrypt(plain, key, :base64), key, :base64)).to eq plain
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,3 @@
1
+ require "rspec"
2
+ require "rspec/autorun"
3
+ require "cfmx_compat"
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: cfmx_compat
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Jason Lambert
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-12-05 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: bundler
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ~>
20
+ - !ruby/object:Gem::Version
21
+ version: '1.3'
22
+ type: :development
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ~>
28
+ - !ruby/object:Gem::Version
29
+ version: '1.3'
30
+ - !ruby/object:Gem::Dependency
31
+ name: rake
32
+ requirement: !ruby/object:Gem::Requirement
33
+ none: false
34
+ requirements:
35
+ - - ! '>='
36
+ - !ruby/object:Gem::Version
37
+ version: '0'
38
+ type: :development
39
+ prerelease: false
40
+ version_requirements: !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ! '>='
44
+ - !ruby/object:Gem::Version
45
+ version: '0'
46
+ - !ruby/object:Gem::Dependency
47
+ name: rspec
48
+ requirement: !ruby/object:Gem::Requirement
49
+ none: false
50
+ requirements:
51
+ - - ! '>='
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ type: :development
55
+ prerelease: false
56
+ version_requirements: !ruby/object:Gem::Requirement
57
+ none: false
58
+ requirements:
59
+ - - ! '>='
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ description: A Ruby encryption library compatible with the CFMX_COMPAT standard used
63
+ in ColdFusion
64
+ email:
65
+ - jlambert@globalpersonals.co.uk
66
+ executables: []
67
+ extensions: []
68
+ extra_rdoc_files: []
69
+ files:
70
+ - .gitignore
71
+ - Gemfile
72
+ - LICENSE.txt
73
+ - README.md
74
+ - Rakefile
75
+ - cfmx_compat.gemspec
76
+ - lib/cfmx_compat.rb
77
+ - lib/cfmx_compat/version.rb
78
+ - spec/cfmx_compat/cfmx_compat_spec.rb
79
+ - spec/spec_helper.rb
80
+ homepage: https://github.com/globaldev/cfmx_compat
81
+ licenses:
82
+ - LGPL
83
+ post_install_message:
84
+ rdoc_options: []
85
+ require_paths:
86
+ - lib
87
+ required_ruby_version: !ruby/object:Gem::Requirement
88
+ none: false
89
+ requirements:
90
+ - - ! '>='
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ segments:
94
+ - 0
95
+ hash: 849020338133939857
96
+ required_rubygems_version: !ruby/object:Gem::Requirement
97
+ none: false
98
+ requirements:
99
+ - - ! '>='
100
+ - !ruby/object:Gem::Version
101
+ version: '0'
102
+ segments:
103
+ - 0
104
+ hash: 849020338133939857
105
+ requirements: []
106
+ rubyforge_project:
107
+ rubygems_version: 1.8.24
108
+ signing_key:
109
+ specification_version: 3
110
+ summary: A Ruby encryption library compatible with the CFMX_COMPAT standard used in
111
+ ColdFusion
112
+ test_files:
113
+ - spec/cfmx_compat/cfmx_compat_spec.rb
114
+ - spec/spec_helper.rb