Skip to content

Commit 1222921

Browse files
author
Jethro Beekman
committed
Initial release
0 parents  commit 1222921

File tree

767 files changed

+180072
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

767 files changed

+180072
-0
lines changed

‎README.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# mbedtls
2+
3+
This is an idiomatic Rust wrapper for mbedTLS, allowing you to use mbedTLS with
4+
only safe code while being able to use such great Rust features like error
5+
handling and closures.
6+
7+
Additionally, building on mbedTLS's focus on embedded use, this crate can be
8+
used in a no_std environment.
9+
10+
## Building
11+
12+
This crate depends on the mbedtls-sys-auto crate, see below for build details.
13+
14+
### Features
15+
16+
This is a list of the Cargo features available for mbedtls-sys. Features in
17+
**bold** are enabled by default.
18+
19+
* *core_io* On no_std, you must enable this feature. It will supply the I/O
20+
Read and Write traits.
21+
* **collections** Enable functions using `String` and `Vec`. On no_std, you
22+
must also enable the *core_io_collections* feature.
23+
* *force_aesni_support* mbedTLS normally uses runtime detection of AES-NI
24+
support. With this feature, always use AES-NI. This
25+
will result in undefined instruction exceptions on
26+
unsupported processors.
27+
* *pthread* Enable mutex synchronization using pthreads.
28+
* *rdrand* Enable the RDRAND random number generator.
29+
* *spin_threading* Enable mutex synchronization using the spin crate.
30+
* **std** If this feature is not enabled, this crate is a no_std crate. (An
31+
allocator is *required*) The necessary C functions to make mbedTLS
32+
work without libc will be provided.
33+
34+
PRs adding new features are encouraged.
35+
36+
# mbedtls-sys-auto
37+
38+
Unfortunately, between the time I developed this crate and the time I got
39+
around to publishing it, someone else already took the mbedtls-sys crate name,
40+
hence the different name.
41+
42+
To use this crate, you will need to have **clang** and **cmake** installed, see
43+
below for details.
44+
45+
## Configuring and linking mbedTLS
46+
47+
mbedTLS has a plethora of compile-time configuration options that significantly
48+
impact what functionality is available. To make sure Rust's view of mbedTLS
49+
matches up with what's built in C, mbedTLS must be configured using Cargo
50+
features (see next section) and built using mbedtls-sys's build script.
51+
52+
The mbedtls-sys crate includes the mbedTLS source code, the mbedTLS version
53+
will have the same major.minor version as the crate. Instead of using the
54+
provided source, you can specify the path to your own source tree using the
55+
`RUST_MBEDTLS_SYS_SOURCE` environment variable. It is not recommended to use a
56+
custom source that is based on a different version of mbedTLS than the one
57+
provided in the crate.
58+
59+
The build script will perform the following steps:
60+
1. generate an appropriate config.h (any existing config.h is ignored),
61+
2. compile a statically-linked mbedTLS, this requires cmake to be installed,
62+
3. generate Rust bindings based on the configuration, this requires clang to be
63+
installed.
64+
65+
### Features
66+
67+
This is a list of the Cargo features available for mbedtls-sys. Features in
68+
**bold** are enabled by default.
69+
70+
* *custom_has_support* Override runtime feature detection. In a dependent
71+
crate, you must define the functions
72+
`mbedtls_aesni_has_support` and
73+
`mbedtls_padlock_has_support` following the mbedTLS
74+
function signatures.
75+
* *custom_printf* Provide a custom printf implementation. printf is only used
76+
for the self tests. In a dependent crate, you must define the
77+
`mbedtls_printf` function with the standard printf signature.
78+
* *custom_threading* Provide a custom threading implementation. In a dependent
79+
crate, you must define the functions `mbedtls_mutex_init`,
80+
`mbedtls_mutex_free`, `mbedtls_mutex_lock`, and
81+
`mbedtls_mutex_unlock` following the mbedTLS function
82+
signatures.
83+
* *havege* Enable the Hardware Volatile Entropy Gathering and Expansion
84+
(HAVEGE) algorithm.
85+
* *pkcs11* Enable PKCS#11 support. This requires pkcs11-helper to be installed.
86+
* **pthread** Enable threading support using pthreads.
87+
* **std** If this feature is not enabled, this crate is a no_std crate. In a
88+
no_std configuration without libc, you need to provide your own
89+
versions of the following standard C functions: calloc/free, and
90+
strstr/strlen/strncpy/strncmp/strcmp/snprintf, and
91+
memmove/memcpy/memcmp/memset, and rand/printf. For printf, you can
92+
optionally use the `custom_printf` feature.
93+
* **time** Enable time support.
94+
* **zlib** Enable zlib support.
95+
96+
For the complete mapping of features to config.h defines, see
97+
[mbedtls-sys/build/config.rs]. PRs adding new features are encouraged.
98+
99+
## A note about licensing
100+
101+
mbedTLS is dual-licensed Apache-2.0 / GPL-2.0+, and so is the mbedtls-sys
102+
crate. However, the sources are distributed in two different single-licensed
103+
tarballs. The authors of the mbedtls-sys crate **do not warrant** that the two
104+
versions of the mbedTLS code are exactly the same. This crate includes the
105+
Apache-2.0 version. Since Apache-2.0 is compatible with GPL-3.0+ this is
106+
probably not an issue for people whishing to use mbedtls-sys in a
107+
GPL-3.0+-licensed project, but if you want to use it in a GPL-2.0-licensed
108+
project, you should probably manually specify the GPL-2.0 source when building.

‎mbedtls-sys/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
target
2+
Cargo.lock

‎mbedtls-sys/COPYING-APACHE‎

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
mbedtls-sys - Rust bindings for mbedTLS
2+
Copyright (C) 2016 Jethro G. Beekman
3+
4+
Apache License
5+
Version 2.0, January 2004
6+
http://www.apache.org/licenses/
7+
8+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
9+
10+
1. Definitions.
11+
12+
"License" shall mean the terms and conditions for use, reproduction,
13+
and distribution as defined by Sections 1 through 9 of this document.
14+
15+
"Licensor" shall mean the copyright owner or entity authorized by
16+
the copyright owner that is granting the License.
17+
18+
"Legal Entity" shall mean the union of the acting entity and all
19+
other entities that control, are controlled by, or are under common
20+
control with that entity. For the purposes of this definition,
21+
"control" means (i) the power, direct or indirect, to cause the
22+
direction or management of such entity, whether by contract or
23+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
24+
outstanding shares, or (iii) beneficial ownership of such entity.
25+
26+
"You" (or "Your") shall mean an individual or Legal Entity
27+
exercising permissions granted by this License.
28+
29+
"Source" form shall mean the preferred form for making modifications,
30+
including but not limited to software source code, documentation
31+
source, and configuration files.
32+
33+
"Object" form shall mean any form resulting from mechanical
34+
transformation or translation of a Source form, including but
35+
not limited to compiled object code, generated documentation,
36+
and conversions to other media types.
37+
38+
"Work" shall mean the work of authorship, whether in Source or
39+
Object form, made available under the License, as indicated by a
40+
copyright notice that is included in or attached to the work
41+
(an example is provided in the Appendix below).
42+
43+
"Derivative Works" shall mean any work, whether in Source or Object
44+
form, that is based on (or derived from) the Work and for which the
45+
editorial revisions, annotations, elaborations, or other modifications
46+
represent, as a whole, an original work of authorship. For the purposes
47+
of this License, Derivative Works shall not include works that remain
48+
separable from, or merely link (or bind by name) to the interfaces of,
49+
the Work and Derivative Works thereof.
50+
51+
"Contribution" shall mean any work of authorship, including
52+
the original version of the Work and any modifications or additions
53+
to that Work or Derivative Works thereof, that is intentionally
54+
submitted to Licensor for inclusion in the Work by the copyright owner
55+
or by an individual or Legal Entity authorized to submit on behalf of
56+
the copyright owner. For the purposes of this definition, "submitted"
57+
means any form of electronic, verbal, or written communication sent
58+
to the Licensor or its representatives, including but not limited to
59+
communication on electronic mailing lists, source code control systems,
60+
and issue tracking systems that are managed by, or on behalf of, the
61+
Licensor for the purpose of discussing and improving the Work, but
62+
excluding communication that is conspicuously marked or otherwise
63+
designated in writing by the copyright owner as "Not a Contribution."
64+
65+
"Contributor" shall mean Licensor and any individual or Legal Entity
66+
on behalf of whom a Contribution has been received by Licensor and
67+
subsequently incorporated within the Work.
68+
69+
2. Grant of Copyright License. Subject to the terms and conditions of
70+
this License, each Contributor hereby grants to You a perpetual,
71+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
72+
copyright license to reproduce, prepare Derivative Works of,
73+
publicly display, publicly perform, sublicense, and distribute the
74+
Work and such Derivative Works in Source or Object form.
75+
76+
3. Grant of Patent License. Subject to the terms and conditions of
77+
this License, each Contributor hereby grants to You a perpetual,
78+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
79+
(except as stated in this section) patent license to make, have made,
80+
use, offer to sell, sell, import, and otherwise transfer the Work,
81+
where such license applies only to those patent claims licensable
82+
by such Contributor that are necessarily infringed by their
83+
Contribution(s) alone or by combination of their Contribution(s)
84+
with the Work to which such Contribution(s) was submitted. If You
85+
institute patent litigation against any entity (including a
86+
cross-claim or counterclaim in a lawsuit) alleging that the Work
87+
or a Contribution incorporated within the Work constitutes direct
88+
or contributory patent infringement, then any patent licenses
89+
granted to You under this License for that Work shall terminate
90+
as of the date such litigation is filed.
91+
92+
4. Redistribution. You may reproduce and distribute copies of the
93+
Work or Derivative Works thereof in any medium, with or without
94+
modifications, and in Source or Object form, provided that You
95+
meet the following conditions:
96+
97+
(a) You must give any other recipients of the Work or
98+
Derivative Works a copy of this License; and
99+
100+
(b) You must cause any modified files to carry prominent notices
101+
stating that You changed the files; and
102+
103+
(c) You must retain, in the Source form of any Derivative Works
104+
that You distribute, all copyright, patent, trademark, and
105+
attribution notices from the Source form of the Work,
106+
excluding those notices that do not pertain to any part of
107+
the Derivative Works; and
108+
109+
(d) If the Work includes a "NOTICE" text file as part of its
110+
distribution, then any Derivative Works that You distribute must
111+
include a readable copy of the attribution notices contained
112+
within such NOTICE file, excluding those notices that do not
113+
pertain to any part of the Derivative Works, in at least one
114+
of the following places: within a NOTICE text file distributed
115+
as part of the Derivative Works; within the Source form or
116+
documentation, if provided along with the Derivative Works; or,
117+
within a display generated by the Derivative Works, if and
118+
wherever such third-party notices normally appear. The contents
119+
of the NOTICE file are for informational purposes only and
120+
do not modify the License. You may add Your own attribution
121+
notices within Derivative Works that You distribute, alongside
122+
or as an addendum to the NOTICE text from the Work, provided
123+
that such additional attribution notices cannot be construed
124+
as modifying the License.
125+
126+
You may add Your own copyright statement to Your modifications and
127+
may provide additional or different license terms and conditions
128+
for use, reproduction, or distribution of Your modifications, or
129+
for any such Derivative Works as a whole, provided Your use,
130+
reproduction, and distribution of the Work otherwise complies with
131+
the conditions stated in this License.
132+
133+
5. Submission of Contributions. Unless You explicitly state otherwise,
134+
any Contribution intentionally submitted for inclusion in the Work
135+
by You to the Licensor shall be under the terms and conditions of
136+
this License, without any additional terms or conditions.
137+
Notwithstanding the above, nothing herein shall supersede or modify
138+
the terms of any separate license agreement you may have executed
139+
with Licensor regarding such Contributions.
140+
141+
6. Trademarks. This License does not grant permission to use the trade
142+
names, trademarks, service marks, or product names of the Licensor,
143+
except as required for reasonable and customary use in describing the
144+
origin of the Work and reproducing the content of the NOTICE file.
145+
146+
7. Disclaimer of Warranty. Unless required by applicable law or
147+
agreed to in writing, Licensor provides the Work (and each
148+
Contributor provides its Contributions) on an "AS IS" BASIS,
149+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
150+
implied, including, without limitation, any warranties or conditions
151+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
152+
PARTICULAR PURPOSE. You are solely responsible for determining the
153+
appropriateness of using or redistributing the Work and assume any
154+
risks associated with Your exercise of permissions under this License.
155+
156+
8. Limitation of Liability. In no event and under no legal theory,
157+
whether in tort (including negligence), contract, or otherwise,
158+
unless required by applicable law (such as deliberate and grossly
159+
negligent acts) or agreed to in writing, shall any Contributor be
160+
liable to You for damages, including any direct, indirect, special,
161+
incidental, or consequential damages of any character arising as a
162+
result of this License or out of the use or inability to use the
163+
Work (including but not limited to damages for loss of goodwill,
164+
work stoppage, computer failure or malfunction, or any and all
165+
other commercial damages or losses), even if such Contributor
166+
has been advised of the possibility of such damages.
167+
168+
9. Accepting Warranty or Additional Liability. While redistributing
169+
the Work or Derivative Works thereof, You may choose to offer,
170+
and charge a fee for, acceptance of support, warranty, indemnity,
171+
or other liability obligations and/or rights consistent with this
172+
License. However, in accepting such obligations, You may act only
173+
on Your own behalf and on Your sole responsibility, not on behalf
174+
of any other Contributor, and only if You agree to indemnify,
175+
defend, and hold each Contributor harmless for any liability
176+
incurred by, or claims asserted against, such Contributor by reason
177+
of your accepting any such warranty or additional liability.
178+
179+
END OF TERMS AND CONDITIONS
180+
181+
APPENDIX: How to apply the Apache License to your work.
182+
183+
To apply the Apache License to your work, attach the following
184+
boilerplate notice, with the fields enclosed by brackets "[]"
185+
replaced with your own identifying information. (Don't include
186+
the brackets!) The text should be enclosed in the appropriate
187+
comment syntax for the file format. We also recommend that a
188+
file or class name and description of purpose be included on the
189+
same "printed page" as the copyright notice for easier
190+
identification within third-party archives.
191+
192+
Copyright [yyyy] [name of copyright owner]
193+
194+
Licensed under the Apache License, Version 2.0 (the "License");
195+
you may not use this file except in compliance with the License.
196+
You may obtain a copy of the License at
197+
198+
http://www.apache.org/licenses/LICENSE-2.0
199+
200+
Unless required by applicable law or agreed to in writing, software
201+
distributed under the License is distributed on an "AS IS" BASIS,
202+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
203+
See the License for the specific language governing permissions and
204+
limitations under the License.

0 commit comments

Comments
 (0)