claim_token 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +15 -0
- data/.gitignore +17 -0
- data/.ruby-version +1 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +201 -0
- data/README.md +62 -0
- data/Rakefile +1 -0
- data/claim_token.gemspec +26 -0
- data/lib/claim_token.rb +24 -0
- data/lib/claim_token/configuration.rb +23 -0
- data/lib/claim_token/decryptor.rb +49 -0
- data/lib/claim_token/encryptor.rb +55 -0
- data/lib/claim_token/signer.rb +13 -0
- data/lib/claim_token/version.rb +3 -0
- data/spec/claim_token_spec.rb +34 -0
- data/spec/configuration_spec.rb +69 -0
- data/spec/decryptor_spec.rb +27 -0
- data/spec/encryptor_spec.rb +26 -0
- data/spec/quality_spec.rb +88 -0
- data/spec/spec_helper.rb +36 -0
- metadata +126 -0
checksums.yaml
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
!binary "U0hBMQ==":
|
3
|
+
metadata.gz: !binary |-
|
4
|
+
MGRiNDQzNjc4ZGUwNThlNTgzZTVlNzNhN2NkYzNkYjY3OGMwOTM3Ng==
|
5
|
+
data.tar.gz: !binary |-
|
6
|
+
MGM3ZWVhYjgzMjczYzYzN2NkNzRmZTllNzNjZWE3M2E4YjM3MjEwMw==
|
7
|
+
SHA512:
|
8
|
+
metadata.gz: !binary |-
|
9
|
+
YmI2MDk3NDE2ZjQ0OWZmOWE3ZjdkNzQ1YWVjY2NkNzkzOTM2NTY2OWQ5Yjcx
|
10
|
+
NzJjYmFlZmRmM2M0ODMwOTdlNzlhY2ZkODMyOGI0NmU3N2ZhNjQ2MGMxZWY5
|
11
|
+
M2E0OGY2OGU5ZTA4YmQ0MjBlNGIwYjRmMmQ0NTU0YzBhOWRhNDY=
|
12
|
+
data.tar.gz: !binary |-
|
13
|
+
ZGJjM2MzNTczYjYwZWMzZTVmNjA4OGEyN2Y0NTNjNmRmMDMyMTU4MDcwYjQx
|
14
|
+
MzJjNzVjNWI4ZGFjYzVkNWRmNjcwN2MyMTU4ZjA4YWZiYzFiMmE2MDhmNjZj
|
15
|
+
ZGMyNTcwNzNlMTY4ODlkMTM4ZTQ1OTExMTdmZDJkOWYwMmU5OWI=
|
data/.gitignore
ADDED
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
ruby-1.9.3-p448
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
[![Code Climate](https://codeclimate.com/github/NuffieProductions/ClaimToken.png)](https://codeclimate.com/github/NuffieProductions/ClaimToken)
|
2
|
+
<img src="https://codeclimate.com/repos/52d4a365e30ba00f2700256c/badges/e0b32fe49c4b5695cdf1/coverage.png"><br/>
|
3
|
+
<img src="https://circleci.com/gh/NuffieProductions/ClaimToken.png?circle-token=39bd4a9416dd8d9f3f7f647d63565297e2e77a11" />
|
4
|
+
# ClaimToken
|
5
|
+
|
6
|
+
ClaimToken encrypts and signs tokens to be used in a claim-based authentication system
|
7
|
+
|
8
|
+
## Installation
|
9
|
+
|
10
|
+
Add this line to your application's Gemfile:
|
11
|
+
|
12
|
+
gem 'claim_token'
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
$ bundle
|
17
|
+
|
18
|
+
Or install it yourself as:
|
19
|
+
|
20
|
+
$ gem install claim_token
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
ClaimToken.configure do |config|
|
25
|
+
config.cipher_type = "aes-256-cbc" # this is the default
|
26
|
+
config.shared_encryption_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
|
27
|
+
config.digest_secret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
|
28
|
+
end
|
29
|
+
|
30
|
+
To encrypt and encode a claim token:
|
31
|
+
|
32
|
+
token = {"your_permissions" => "I HAZ THEM", "expires" => "2014-01-14T01:26:07Z"}
|
33
|
+
ClaimToken.pack(token)
|
34
|
+
|
35
|
+
To decode and decrypt a claim token:
|
36
|
+
|
37
|
+
packed_token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX..."
|
38
|
+
ClaimToken.extract(packed_token)
|
39
|
+
|
40
|
+
## Contributing
|
41
|
+
|
42
|
+
1. Fork it
|
43
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
44
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
45
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
46
|
+
5. Create new Pull Request
|
47
|
+
|
48
|
+
## License
|
49
|
+
|
50
|
+
Copyright 2014 CricHQ Limited
|
51
|
+
|
52
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
53
|
+
you may not use this file except in compliance with the License.
|
54
|
+
You may obtain a copy of the License at
|
55
|
+
|
56
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
57
|
+
|
58
|
+
Unless required by applicable law or agreed to in writing, software
|
59
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
60
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
61
|
+
See the License for the specific language governing permissions and
|
62
|
+
limitations under the License.
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/claim_token.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'claim_token/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "claim_token"
|
8
|
+
spec.version = ClaimToken::VERSION
|
9
|
+
spec.authors = ["Daniel Zollinger"]
|
10
|
+
spec.email = ["daniel.zollinger@crichq.com"]
|
11
|
+
spec.description = %q{ClaimToken encrypts and signs tokens to be used in a claim-based authentication system}
|
12
|
+
spec.summary = %q{Encrypt heem! Sign heem! Claim heem!}
|
13
|
+
spec.homepage = "http://github.com/NuffieProductions/ClaimToken"
|
14
|
+
spec.license = "Apache 2.0"
|
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.required_ruby_version = '>= 1.9.3'
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
23
|
+
spec.add_development_dependency "rake"
|
24
|
+
spec.add_development_dependency "rspec"
|
25
|
+
spec.add_development_dependency "codeclimate-test-reporter"
|
26
|
+
end
|
data/lib/claim_token.rb
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
require 'claim_token/configuration'
|
2
|
+
require "claim_token/version"
|
3
|
+
require 'claim_token/signer'
|
4
|
+
require 'claim_token/encryptor'
|
5
|
+
require 'claim_token/decryptor'
|
6
|
+
|
7
|
+
module ClaimToken
|
8
|
+
|
9
|
+
def self.extract encoded_token
|
10
|
+
decrypt(JSON.parse( Base64.urlsafe_decode64(encoded_token)))
|
11
|
+
end
|
12
|
+
|
13
|
+
def self.pack message
|
14
|
+
Base64.urlsafe_encode64(JSON.dump(encrypt(message)))
|
15
|
+
end
|
16
|
+
|
17
|
+
def self.encrypt message
|
18
|
+
ClaimToken::Encryptor.encrypt(message)
|
19
|
+
end
|
20
|
+
|
21
|
+
def self.decrypt encrypted_token
|
22
|
+
ClaimToken::Decryptor.decrypt(encrypted_token)
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
module ClaimToken
|
2
|
+
|
3
|
+
DEFAULT_CIPHER_TYPE = "aes-256-cbc"
|
4
|
+
|
5
|
+
class Configuration
|
6
|
+
attr_accessor :shared_encryption_key, :digest_secret, :cipher_type
|
7
|
+
|
8
|
+
def initialize
|
9
|
+
@cipher_type = DEFAULT_CIPHER_TYPE
|
10
|
+
@shared_encryption_key = :no_shared_encryption_key_set
|
11
|
+
@digest_secret = :no_digest_secret_set
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
class << self
|
16
|
+
attr_accessor :configuration
|
17
|
+
end
|
18
|
+
|
19
|
+
def self.configure
|
20
|
+
self.configuration ||= Configuration.new
|
21
|
+
yield configuration
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
require 'json'
|
2
|
+
require 'openssl'
|
3
|
+
require 'base64'
|
4
|
+
|
5
|
+
module ClaimToken
|
6
|
+
|
7
|
+
module Decryptor
|
8
|
+
|
9
|
+
module_function
|
10
|
+
|
11
|
+
def decrypt encrypted_token
|
12
|
+
check_signature! encrypted_token
|
13
|
+
|
14
|
+
cipher = build_cipher(encrypted_token)
|
15
|
+
|
16
|
+
decrypted = decrypt_token_with_cipher(encrypted_token, cipher)
|
17
|
+
|
18
|
+
JSON.parse(decrypted)
|
19
|
+
end
|
20
|
+
|
21
|
+
def check_signature! token
|
22
|
+
signature = token.fetch("signature")
|
23
|
+
real_signature = ClaimToken::Signer.sign(token.fetch("data"))
|
24
|
+
|
25
|
+
raise "IncorrectSignature" unless signature == real_signature
|
26
|
+
end
|
27
|
+
|
28
|
+
def build_cipher token
|
29
|
+
cipher = OpenSSL::Cipher::Cipher.new( token.fetch("cipher") )
|
30
|
+
cipher.decrypt
|
31
|
+
cipher.key = encryption_key
|
32
|
+
cipher.iv = decode(token.fetch("iv"))
|
33
|
+
return cipher
|
34
|
+
end
|
35
|
+
|
36
|
+
def decrypt_token_with_cipher token, cipher
|
37
|
+
decrypted = cipher.update decode(token.fetch("data"))
|
38
|
+
decrypted << cipher.final
|
39
|
+
end
|
40
|
+
|
41
|
+
def encryption_key
|
42
|
+
ClaimToken.configuration.shared_encryption_key
|
43
|
+
end
|
44
|
+
|
45
|
+
def decode encoded_string
|
46
|
+
Base64.urlsafe_decode64 encoded_string
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
require 'json'
|
2
|
+
require 'openssl'
|
3
|
+
require 'base64'
|
4
|
+
|
5
|
+
module ClaimToken
|
6
|
+
|
7
|
+
module Encryptor
|
8
|
+
|
9
|
+
module_function
|
10
|
+
|
11
|
+
def encrypt message
|
12
|
+
message_json = JSON.dump(message)
|
13
|
+
|
14
|
+
cipher, iv = build_cipher
|
15
|
+
|
16
|
+
encrypted_data = encrypt_message_with_cipher message_json, cipher
|
17
|
+
|
18
|
+
encoded_encrypted_data = encode(encrypted_data)
|
19
|
+
|
20
|
+
signature = ClaimToken::Signer.sign(encoded_encrypted_data)
|
21
|
+
|
22
|
+
{
|
23
|
+
"type" => "EncryptedMessage",
|
24
|
+
"cipher" => cipher_type,
|
25
|
+
"data" => encoded_encrypted_data,
|
26
|
+
"iv" => encode(iv),
|
27
|
+
"signature" => signature,
|
28
|
+
}
|
29
|
+
end
|
30
|
+
|
31
|
+
def build_cipher
|
32
|
+
cipher = OpenSSL::Cipher::Cipher.new(cipher_type)
|
33
|
+
cipher.encrypt
|
34
|
+
cipher.key = encryption_key
|
35
|
+
cipher.iv = iv = cipher.random_iv
|
36
|
+
return [cipher, iv]
|
37
|
+
end
|
38
|
+
|
39
|
+
def cipher_type
|
40
|
+
ClaimToken.configuration.cipher_type
|
41
|
+
end
|
42
|
+
|
43
|
+
def encryption_key
|
44
|
+
ClaimToken.configuration.shared_encryption_key
|
45
|
+
end
|
46
|
+
|
47
|
+
def encrypt_message_with_cipher message, cipher
|
48
|
+
cipher.update(message.encode("UTF-8")) + cipher.final
|
49
|
+
end
|
50
|
+
|
51
|
+
def encode raw_string
|
52
|
+
Base64.urlsafe_encode64 raw_string
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
require 'claim_token'
|
3
|
+
|
4
|
+
describe ClaimToken do
|
5
|
+
|
6
|
+
use_test_configuration
|
7
|
+
|
8
|
+
let(:encoded_token) {
|
9
|
+
"eyJ0eXBlIjoiRW5jcnlwdGVkTWVzc2FnZSIsImNpcGhlciI6ImFlcy0yNTYtY2Jj" +
|
10
|
+
"IiwiZGF0YSI6InVSZnpMUEZFYzh5VDV3Q0ZiTDItSUE9PSIsIml2IjoiQ2tzUFhq" +
|
11
|
+
"Rlk1b29uMjJhNGsybWpuUT09Iiwic2lnbmF0dXJlIjoiMjc1MTNhY2U1ZTQwN2Y3" +
|
12
|
+
"NWFhOWJmZjJjMzIzOTc2OWM5YTFiOWQyMCJ9"
|
13
|
+
}
|
14
|
+
|
15
|
+
describe ".extract" do
|
16
|
+
it "extracts a packed token" do
|
17
|
+
extracted_token = ClaimToken.extract(encoded_token)
|
18
|
+
|
19
|
+
expect( extracted_token ).to eql({"foo" => "bar"})
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
describe ".pack" do
|
24
|
+
stub_random_iv
|
25
|
+
|
26
|
+
it "packs a token" do
|
27
|
+
raw_token = {"foo" => "bar"}
|
28
|
+
|
29
|
+
packed_token = ClaimToken.pack(raw_token)
|
30
|
+
|
31
|
+
expect( packed_token ).to eq encoded_token
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,69 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
require 'claim_token'
|
3
|
+
|
4
|
+
describe ClaimToken::Configuration do
|
5
|
+
after do
|
6
|
+
restore_default_config
|
7
|
+
end
|
8
|
+
|
9
|
+
context "when no cipher is specified" do
|
10
|
+
before do
|
11
|
+
ClaimToken.configure do |config|
|
12
|
+
end
|
13
|
+
end
|
14
|
+
|
15
|
+
it "defaults to AES 256 with CBC" do
|
16
|
+
expect( ClaimToken.configuration.cipher_type ).to eq ClaimToken::DEFAULT_CIPHER_TYPE
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
context "when no shared encryption key is set" do
|
21
|
+
before do
|
22
|
+
ClaimToken.configure do |config|
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
it "defaults to a descriptive symbol" do
|
27
|
+
expect( ClaimToken.configuration.shared_encryption_key ).to eq( :no_shared_encryption_key_set )
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
context "when a shared encryption key is set" do
|
32
|
+
let(:shared_key) { "Test Shared Encryption Key" }
|
33
|
+
|
34
|
+
before do
|
35
|
+
ClaimToken.configure do |config|
|
36
|
+
config.shared_encryption_key = shared_key
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
it "returns the shared encryption key" do
|
41
|
+
expect( ClaimToken.configuration.shared_encryption_key ).to eq( shared_key )
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
context "when no digest secret is set" do
|
46
|
+
before do
|
47
|
+
ClaimToken.configure do |config|
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
it "defaults to a descriptive symbol" do
|
52
|
+
expect( ClaimToken.configuration.digest_secret ).to eq( :no_digest_secret_set )
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
context "when a digest secret is set" do
|
57
|
+
let(:digest_secret) { "Test Digest Key" }
|
58
|
+
|
59
|
+
before do
|
60
|
+
ClaimToken.configure do |config|
|
61
|
+
config.digest_secret = digest_secret
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
it "returns the digest secret" do
|
66
|
+
expect( ClaimToken.configuration.digest_secret ).to eq( digest_secret )
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
require 'claim_token'
|
3
|
+
|
4
|
+
describe ClaimToken::Decryptor do
|
5
|
+
use_test_configuration
|
6
|
+
|
7
|
+
describe :decrypt do
|
8
|
+
|
9
|
+
let(:token_data) {
|
10
|
+
{
|
11
|
+
"type" => "EncryptedMessage",
|
12
|
+
"cipher" => "aes-256-cbc",
|
13
|
+
"data" => "P_2kgNhGBCu2WaF5lM3foW-tGdaJ3O_5tYSmhqg7rtI=",
|
14
|
+
"iv" => "CksPXjFY5oon22a4k2mjnQ==",
|
15
|
+
"signature" => "25efcdc87bae25dd0844a74db58462640d705f11",
|
16
|
+
}
|
17
|
+
}
|
18
|
+
|
19
|
+
it "returns a decrypted message" do
|
20
|
+
expect( ClaimToken::Decryptor.decrypt(token_data) ).to eql({"foo" => "bar", "expires" => "NOW"})
|
21
|
+
end
|
22
|
+
|
23
|
+
it "errors on bad signature" do
|
24
|
+
expect { ClaimToken::Decryptor.decrypt(token_data.merge!("signature" => "12345")) }.to raise_error("IncorrectSignature")
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
require 'claim_token'
|
3
|
+
|
4
|
+
describe ClaimToken::Encryptor do
|
5
|
+
use_test_configuration
|
6
|
+
|
7
|
+
describe :encrypt do
|
8
|
+
|
9
|
+
let(:token_data) {
|
10
|
+
{
|
11
|
+
"type" => "EncryptedMessage",
|
12
|
+
"cipher" => "aes-256-cbc",
|
13
|
+
"data" => "P_2kgNhGBCu2WaF5lM3foW-tGdaJ3O_5tYSmhqg7rtI=",
|
14
|
+
"iv" => "CksPXjFY5oon22a4k2mjnQ==",
|
15
|
+
"signature" => "25efcdc87bae25dd0844a74db58462640d705f11",
|
16
|
+
}
|
17
|
+
}
|
18
|
+
|
19
|
+
stub_random_iv
|
20
|
+
|
21
|
+
it "returns an encrypted token" do
|
22
|
+
token = ClaimToken::Encryptor.encrypt({foo: "bar", expires: "NOW"})
|
23
|
+
expect( token ).to eql( token_data )
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,88 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
if defined?(Encoding) && Encoding.default_external != "UTF-8"
|
4
|
+
Encoding.default_external = "UTF-8"
|
5
|
+
end
|
6
|
+
|
7
|
+
describe "The library itself" do
|
8
|
+
def check_for_spec_defs_with_single_quotes(filename)
|
9
|
+
failing_lines = []
|
10
|
+
|
11
|
+
File.readlines(filename).each_with_index do |line,number|
|
12
|
+
failing_lines << number + 1 if line =~ /^ *(describe|it|context) {1}'{1}/
|
13
|
+
end
|
14
|
+
|
15
|
+
unless failing_lines.empty?
|
16
|
+
"#{filename} uses inconsistent single quotes on lines #{failing_lines.join(', ')}"
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
def check_for_tab_characters(filename)
|
21
|
+
failing_lines = []
|
22
|
+
File.readlines(filename).each_with_index do |line,number|
|
23
|
+
failing_lines << number + 1 if line =~ /\t/
|
24
|
+
end
|
25
|
+
|
26
|
+
unless failing_lines.empty?
|
27
|
+
"#{filename} has tab characters on lines #{failing_lines.join(', ')}"
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def check_for_extra_spaces(filename)
|
32
|
+
failing_lines = []
|
33
|
+
File.readlines(filename).each_with_index do |line,number|
|
34
|
+
next if line =~ /^\s+#.*\s+\n$/
|
35
|
+
next if %w(LICENCE.md).include?(line)
|
36
|
+
failing_lines << number + 1 if line =~ /\s+\n$/
|
37
|
+
end
|
38
|
+
|
39
|
+
unless failing_lines.empty?
|
40
|
+
"#{filename} has spaces on the EOL on lines #{failing_lines.join(', ')}"
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
RSpec::Matchers.define :be_well_formed do
|
45
|
+
failure_message_for_should do |actual|
|
46
|
+
actual.join("\n")
|
47
|
+
end
|
48
|
+
|
49
|
+
match do |actual|
|
50
|
+
actual.empty?
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
it "has no malformed whitespace" do
|
55
|
+
exempt = /\.gitmodules|\.marshal|fixtures|vendor|ssl_certs|LICENSE/
|
56
|
+
error_messages = []
|
57
|
+
Dir.chdir(File.expand_path("../..", __FILE__)) do
|
58
|
+
`git ls-files -z`.split("\x0").each do |filename|
|
59
|
+
next if filename =~ exempt
|
60
|
+
error_messages << check_for_tab_characters(filename)
|
61
|
+
error_messages << check_for_extra_spaces(filename)
|
62
|
+
end
|
63
|
+
end
|
64
|
+
expect(error_messages.compact).to be_well_formed
|
65
|
+
end
|
66
|
+
|
67
|
+
it "uses double-quotes consistently in specs" do
|
68
|
+
included = /spec/
|
69
|
+
error_messages = []
|
70
|
+
Dir.chdir(File.expand_path("../", __FILE__)) do
|
71
|
+
`git ls-files -z`.split("\x0").each do |filename|
|
72
|
+
next unless filename =~ included
|
73
|
+
error_messages << check_for_spec_defs_with_single_quotes(filename)
|
74
|
+
end
|
75
|
+
end
|
76
|
+
expect(error_messages.compact).to be_well_formed
|
77
|
+
end
|
78
|
+
|
79
|
+
it "can still be built" do
|
80
|
+
Dir.chdir(File.expand_path("../..", __FILE__)) do
|
81
|
+
`gem build claim_token.gemspec`
|
82
|
+
expect($?).to eq(0)
|
83
|
+
|
84
|
+
# clean up the .gem generated
|
85
|
+
system("rm claim_token-#{ClaimToken::VERSION}.gem")
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,36 @@
|
|
1
|
+
# Test coverage startup
|
2
|
+
if ENV['CODECLIMATE_REPO_TOKEN'] # For delicious CodeClimate coverage
|
3
|
+
require "codeclimate-test-reporter"
|
4
|
+
CodeClimate::TestReporter.start
|
5
|
+
elsif ENV['SIMPLECOV']
|
6
|
+
# Set the environment variable if you want to generate a detailed
|
7
|
+
# coverage report on your local box
|
8
|
+
require "simplecov"
|
9
|
+
SimpleCov.start
|
10
|
+
end
|
11
|
+
|
12
|
+
def stub_random_iv
|
13
|
+
before do
|
14
|
+
cipher = OpenSSL::Cipher::Cipher.new(ClaimToken.configuration.cipher_type)
|
15
|
+
cipher.stub(random_iv: "\nK\x0F^1X\xE6\x8A'\xDBf\xB8\x93i\xA3\x9D")
|
16
|
+
OpenSSL::Cipher::Cipher.stub(new: cipher)
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
def use_test_configuration
|
21
|
+
before do
|
22
|
+
ClaimToken.configure do |config|
|
23
|
+
config.shared_encryption_key = "uFeb25D_z0BAGhgH7WKy8QBSat6kxfDa6PrKw1ox69U="
|
24
|
+
config.digest_secret = "d22b90c9172649eaf49cd185f73bd4a53ec3ff4dc6f7d51f9dbaac62421e6dd297b38efcd431a7f2"
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
after do
|
29
|
+
restore_default_config
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
def restore_default_config
|
34
|
+
ClaimToken.configuration = nil
|
35
|
+
ClaimToken.configure {}
|
36
|
+
end
|
metadata
ADDED
@@ -0,0 +1,126 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: claim_token
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Daniel Zollinger
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-01-14 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.3'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ! '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ! '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ! '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ! '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: codeclimate-test-reporter
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ! '>='
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
description: ClaimToken encrypts and signs tokens to be used in a claim-based authentication
|
70
|
+
system
|
71
|
+
email:
|
72
|
+
- daniel.zollinger@crichq.com
|
73
|
+
executables: []
|
74
|
+
extensions: []
|
75
|
+
extra_rdoc_files: []
|
76
|
+
files:
|
77
|
+
- .gitignore
|
78
|
+
- .ruby-version
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE.txt
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- claim_token.gemspec
|
84
|
+
- lib/claim_token.rb
|
85
|
+
- lib/claim_token/configuration.rb
|
86
|
+
- lib/claim_token/decryptor.rb
|
87
|
+
- lib/claim_token/encryptor.rb
|
88
|
+
- lib/claim_token/signer.rb
|
89
|
+
- lib/claim_token/version.rb
|
90
|
+
- spec/claim_token_spec.rb
|
91
|
+
- spec/configuration_spec.rb
|
92
|
+
- spec/decryptor_spec.rb
|
93
|
+
- spec/encryptor_spec.rb
|
94
|
+
- spec/quality_spec.rb
|
95
|
+
- spec/spec_helper.rb
|
96
|
+
homepage: http://github.com/NuffieProductions/ClaimToken
|
97
|
+
licenses:
|
98
|
+
- Apache 2.0
|
99
|
+
metadata: {}
|
100
|
+
post_install_message:
|
101
|
+
rdoc_options: []
|
102
|
+
require_paths:
|
103
|
+
- lib
|
104
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
105
|
+
requirements:
|
106
|
+
- - ! '>='
|
107
|
+
- !ruby/object:Gem::Version
|
108
|
+
version: 1.9.3
|
109
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
110
|
+
requirements:
|
111
|
+
- - ! '>='
|
112
|
+
- !ruby/object:Gem::Version
|
113
|
+
version: '0'
|
114
|
+
requirements: []
|
115
|
+
rubyforge_project:
|
116
|
+
rubygems_version: 2.1.11
|
117
|
+
signing_key:
|
118
|
+
specification_version: 4
|
119
|
+
summary: Encrypt heem! Sign heem! Claim heem!
|
120
|
+
test_files:
|
121
|
+
- spec/claim_token_spec.rb
|
122
|
+
- spec/configuration_spec.rb
|
123
|
+
- spec/decryptor_spec.rb
|
124
|
+
- spec/encryptor_spec.rb
|
125
|
+
- spec/quality_spec.rb
|
126
|
+
- spec/spec_helper.rb
|