ore-rs 0.7.0-x86_64-linux
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CODEOWNERS +2 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/CONTRIBUTING.md +10 -0
- data/LICENCE +124 -0
- data/README.md +72 -0
- data/ext/ore_rs/.gitignore +4 -0
- data/ext/ore_rs/Cargo.lock +741 -0
- data/ext/ore_rs/Cargo.toml +14 -0
- data/ext/ore_rs/extconf.rb +4 -0
- data/ext/ore_rs/src/lib.rs +142 -0
- data/lib/2.7/ore_rs.so +0 -0
- data/lib/3.0/ore_rs.so +0 -0
- data/lib/3.1/ore_rs.so +0 -0
- data/lib/ore/aes128/ciphertext.rb +47 -0
- data/lib/ore/aes128.rb +204 -0
- data/lib/ore/version.rb +3 -0
- data/lib/ore-rs.rb +15 -0
- data/ore-rs.gemspec +43 -0
- metadata +241 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4561a9303b7fe31c0c3df7f70f68e405eccece788698e5f1c3d5beac1529df4f
|
4
|
+
data.tar.gz: 994bfa8a227115103085b2c69a74a5c5c4c974a553b187d6f2e05348a1fbc53a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e6ff41118e3c57975958c7db69e8875f4bc86e60b38b952d6f820abe29e9bb14f27dffdcca10800f499c885b3b180e4a54eaca4f60d36fa68ea86181cd80aeb7
|
7
|
+
data.tar.gz: aa9f4da3ebdf154a599844226d96d0ebf501fbf310ff943e9d1c5a1e597ff66abe54b5d43e8fde1777d5f08a371d9a43b077e43091d765c86b3047cb5fd494bd
|
data/CODEOWNERS
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
7
|
+
|
8
|
+
We are committed to making participation in this project a harassment-free
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
12
|
+
|
13
|
+
Examples of unacceptable behavior by participants include:
|
14
|
+
|
15
|
+
* The use of sexualized language or imagery
|
16
|
+
* Personal attacks
|
17
|
+
* Trolling or insulting/derogatory comments
|
18
|
+
* Public or private harassment
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
20
|
+
addresses, without explicit permission
|
21
|
+
* Other unethical or unprofessional conduct
|
22
|
+
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
24
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
25
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
26
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
27
|
+
threatening, offensive, or harmful.
|
28
|
+
|
29
|
+
By adopting this Code of Conduct, project maintainers commit themselves to
|
30
|
+
fairly and consistently applying these principles to every aspect of managing
|
31
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
32
|
+
Conduct may be permanently removed from the project team.
|
33
|
+
|
34
|
+
This code of conduct applies both within project spaces and in public spaces
|
35
|
+
when an individual is representing the project or its community.
|
36
|
+
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
38
|
+
reported by contacting a project maintainer at team@cipherstash.com. All
|
39
|
+
complaints will be reviewed and investigated and will result in a response that
|
40
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
41
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
42
|
+
incident.
|
43
|
+
|
44
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
45
|
+
version 1.3.0, available at
|
46
|
+
[http://contributor-covenant.org/version/1/3/0/][version]
|
47
|
+
|
48
|
+
[homepage]: http://contributor-covenant.org
|
49
|
+
[version]: http://contributor-covenant.org/version/1/3/0/
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
* If you have found a discrepancy in documented and observed behaviour, that
|
2
|
+
is a bug. Feel free to [report it as an
|
3
|
+
issue](https://github.com/cipherstash/ruby-ore-rs/issues), providing
|
4
|
+
sufficient detail to reproduce the problem.
|
5
|
+
|
6
|
+
* If you would like to add new behaviour, please submit a well-tested and
|
7
|
+
well-documented [pull
|
8
|
+
request](https://github.com/cipherstash/ruby-ore-rs/pulls).
|
9
|
+
|
10
|
+
* At all times, abide by the Code of Conduct (CODE_OF_CONDUCT.md).
|
data/LICENCE
ADDED
@@ -0,0 +1,124 @@
|
|
1
|
+
CipherStash Client Library Licence Agreement
|
2
|
+
|
3
|
+
0. Background
|
4
|
+
|
5
|
+
This licence sets out the terms on which you are permitted to use client side
|
6
|
+
components of software provided by CipherStash to query encrypted databases
|
7
|
+
(CipherStash Client Software).The operation of the CipherStash Client Software
|
8
|
+
is dependent on encryption keys generated by server software operated or
|
9
|
+
licensed by CipherStash.
|
10
|
+
|
11
|
+
1. Definitions
|
12
|
+
|
13
|
+
1.1 In these terms the following terms have the following meanings:
|
14
|
+
(a) Authorised Purpose in relation to the CipherStash Source Code has the
|
15
|
+
meaning given to it in clause 2.4;
|
16
|
+
(b) CipherStash Source Code means human readable code of the CipherStash
|
17
|
+
Client Software;
|
18
|
+
(c) CipherStash Executable means the machine executable code of the
|
19
|
+
CipherStash Client Software as made available by CipherStash from
|
20
|
+
time to time;
|
21
|
+
(d) CipherStash Client Software has the meaning given to it in the
|
22
|
+
Background;
|
23
|
+
(e) Licensed Query means a query on a database that:
|
24
|
+
(i) uses an encryption key generated by a key server operated or
|
25
|
+
licensed by CipherStash for all encryption of the content of that
|
26
|
+
query or of results returned in response to that query (excluding
|
27
|
+
encryption in the transport layer for communications between
|
28
|
+
servers); and
|
29
|
+
(ii) uses a valid token provided by CipherStash in the course of
|
30
|
+
acquiring the key referred to in the previous paragraph;
|
31
|
+
(f) Your Applications means applications that you create that rely on any
|
32
|
+
part of the CipherStash Client Software in the course of their
|
33
|
+
operation.
|
34
|
+
1.2 In these terms, unless the context requires otherwise, references to:
|
35
|
+
(a) encryption includes decryption;
|
36
|
+
(b) keys are references to data used for encryption, not data indicating a
|
37
|
+
row in a database table.
|
38
|
+
|
39
|
+
2. Grant of Licence
|
40
|
+
|
41
|
+
2.1 This licence permits you to do the following in relation to the CipherStash
|
42
|
+
Client Software:
|
43
|
+
(a) use the CipherStash Executables in the course of developing and testing
|
44
|
+
Your Applications;
|
45
|
+
(b) deploy and use copies of the CipherStash Executables for the purpose of
|
46
|
+
executing Licensed Queries, including as part of one or more of Your
|
47
|
+
Applications; and
|
48
|
+
(c) use the CipherStash Source Code solely for an Authorised Purpose.
|
49
|
+
2.2 Subject to clause 2.4(c), you must not make any modifications to the
|
50
|
+
CipherStash Client Software.
|
51
|
+
2.3 This licence specifically excludes any use of any part of the CipherStash
|
52
|
+
Client Software to execute any queries other than Licensed Queries on any
|
53
|
+
database.
|
54
|
+
2.4 CipherStash makes the CipherStash Source Code available for the sole purpose
|
55
|
+
of allowing third parties to verify the operation, integrity and security
|
56
|
+
of the CipherStash Client Software (Authorised Purpose). This licence
|
57
|
+
permits you to do the following solely for an Authorised Purpose:
|
58
|
+
(a) download and review the CipherStash Source Code;
|
59
|
+
(b) build executable versions of the CipherStash Source Code to verify
|
60
|
+
correspondence between it and its associated CipherStash Executable;
|
61
|
+
(c) make configuration changes to the CipherStash Source Code solely to the
|
62
|
+
extent necessary to build a working executable version under paragraph
|
63
|
+
(b).
|
64
|
+
|
65
|
+
3. Warranties and Liability
|
66
|
+
|
67
|
+
3.1 To the extent permitted by law, CipherStash excludes all warranties,
|
68
|
+
guarantees and conditions that would otherwise be implied into this
|
69
|
+
agreement by law. Where CipherStash is not able to exclude such a warranty,
|
70
|
+
guarantee or condition, CipherStash limits, to the extent permitted by law,
|
71
|
+
its liability for a breach of that warranty, guarantee or condition to one
|
72
|
+
or more of the following at its option:
|
73
|
+
(a) in the case of goods, any one or more of the following:
|
74
|
+
(i) the replacement of the goods or the supply of equivalent goods;
|
75
|
+
(ii) the repair of the goods;
|
76
|
+
(iii) the payment of the cost of replacing the goods or of acquiring
|
77
|
+
equivalent goods;
|
78
|
+
(iv) the payment of the cost of having the goods repaired; and
|
79
|
+
(b) in the case of services:
|
80
|
+
(i) the supplying of the services again; or
|
81
|
+
(ii) the payment of the cost of having the services supplied again.
|
82
|
+
3.2 CipherStash has no liability to any person arising under or in relation to
|
83
|
+
this agreement (whether in tort, contract, equity or otherwise) for any
|
84
|
+
loss in the nature of consequential or economic loss. In particular,
|
85
|
+
CipherStash has no liability to any person for any: lost profits; loss of
|
86
|
+
savings, income or revenue; revenue not meeting targets or certain levels;
|
87
|
+
uptime or availability of internet connectivity or of the ability of third
|
88
|
+
parties to access a website, loss of opportunity; or loss of or corruption
|
89
|
+
of data. The exclusions in this clause 3.2 apply even in respect of loss or
|
90
|
+
damage that was foreseeable or about which either or both of the parties
|
91
|
+
were aware was likely to arise.
|
92
|
+
|
93
|
+
4. Dispute Resolution
|
94
|
+
|
95
|
+
4.1 Prior to commencing any action in any court or any action in any other form
|
96
|
+
of judicial or quasi-judicial forum you must comply with the requirements
|
97
|
+
of this clause 4.
|
98
|
+
4.2 Where you believe there is a dispute between you and CipherStash in respect
|
99
|
+
of a matter the subject of this agreement you must notify CipherStash in
|
100
|
+
writing of the nature of that dispute and for a period of 120 days
|
101
|
+
following CipherStash’s receipt of that notification, make reasonable
|
102
|
+
attempts to resolve that dispute with CipherStash.
|
103
|
+
|
104
|
+
5. General and Interpretation
|
105
|
+
|
106
|
+
5.1 Except where expressly set out to the contrary, nothing in this agreement
|
107
|
+
grants the Customer any rights over any intellectual property rights
|
108
|
+
(including copyright, patents, and rights to the registration of such
|
109
|
+
rights) held by CipherStash at any time.
|
110
|
+
5.2 No provision of this agreement may be construed against a party because
|
111
|
+
that party drafted that term.
|
112
|
+
5.3 A waiver of rights under this agreement can only occur in writing signed by
|
113
|
+
the party granting the waiver. Except to the extent set out in the waiver,
|
114
|
+
a waiver is only effective in relation to the specific facts and rights set
|
115
|
+
out in it and does not operate to waive any other rights or to waive the
|
116
|
+
same rights in respect of different facts or circumstances.
|
117
|
+
5.4 Where a part of this agreement is held by a court to be illegal or
|
118
|
+
otherwise unenforceable, and the unenforceability of that part does not
|
119
|
+
substantially alter the character of the bargain that would have been in
|
120
|
+
existence between the parties had that part been enforceable, that part is
|
121
|
+
severed and the balance of this agreement will continue unaffected.
|
122
|
+
5.5 This contract is governed by the laws in force in the State of New South
|
123
|
+
Wales, Australia. Each party submits to the non-exclusive jurisdiction of
|
124
|
+
the courts of that State.
|
data/README.md
ADDED
@@ -0,0 +1,72 @@
|
|
1
|
+
Ruby bindings for the [ore.rs](https://github.com/cipherstash/ore.rs) Order-Revealing Encryption Rust library.
|
2
|
+
|
3
|
+
|
4
|
+
# Installation
|
5
|
+
|
6
|
+
For the most common platforms, we provide "native" gems (which have the shared
|
7
|
+
object that provides the cryptographic primitives pre-compiled). At present,
|
8
|
+
we provide native gems for:
|
9
|
+
|
10
|
+
* Linux `x86_64` and `aarch64`
|
11
|
+
* macOS `x86_64` and `arm64`
|
12
|
+
|
13
|
+
On these platforms, you can just install the `ore-rs` gem via your preferred
|
14
|
+
method, and it should "just work". If it doesn't, please [report that as a
|
15
|
+
bug](https://github.com/cipherstash/ruby-ore-rs/issues).
|
16
|
+
|
17
|
+
For other platforms, you will need to install the source gem, which requires
|
18
|
+
that you have Rust 1.57.0 or later installed. On ARM-based platforms, you must
|
19
|
+
use Rust nightly, for SIMD intrinsics support.
|
20
|
+
|
21
|
+
## Installing from Git
|
22
|
+
|
23
|
+
If you have a burning need to install directly from a checkout of the git
|
24
|
+
repository, you can do so by running `bundle install && rake install`. As this
|
25
|
+
is a source-based installation, you will need to have Rust installed, as
|
26
|
+
described above.
|
27
|
+
|
28
|
+
|
29
|
+
# Usage
|
30
|
+
|
31
|
+
First off, load the library:
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
require "ore-rs"
|
35
|
+
```
|
36
|
+
|
37
|
+
Then create a new encryptor:
|
38
|
+
|
39
|
+
```ruby
|
40
|
+
enc = ORE::AES128.new(key1, key2, 64, 8)
|
41
|
+
```
|
42
|
+
|
43
|
+
Encrypt a couple of ciphertexts:
|
44
|
+
|
45
|
+
```ruby
|
46
|
+
ct1 = enc.encrypt(42)
|
47
|
+
ct2 = enc.encrypt(420)
|
48
|
+
```
|
49
|
+
|
50
|
+
Finally, compare them:
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
ct1 < ct2 # => true
|
54
|
+
ct1 > ct2 # => false
|
55
|
+
```
|
56
|
+
|
57
|
+
If you need to store a ciphertext, you can turn it into a binary string:
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
File.write("/tmp/ciphertext", ct1.to_s)
|
61
|
+
```
|
62
|
+
|
63
|
+
To turn a binary string back into a ciphertext, just create a new ciphertext with it:
|
64
|
+
|
65
|
+
```ruby
|
66
|
+
ct3 = ORE::AES128::Ciphertext.new(File.binread("/tmp/ciphertext"), 8)
|
67
|
+
```
|
68
|
+
|
69
|
+
|
70
|
+
# Contributing
|
71
|
+
|
72
|
+
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
|