Skip to content

Commit 24474e4

Browse files
authored
Add a new crate, "cap-net-ext". (#309)
Add a new "cap-net-ext", which has functions that splits out the `socket`, `bind`, and `listen` steps that std normally bundles into a single step (eg. in `TcpListener::bind`). And, add a function to add addresses to a `Pool` by name, allowing users to write things like `pool.insert("example.com")`.
1 parent 84d98ce commit 24474e4

File tree

20 files changed

+2808
-48
lines changed

20 files changed

+2808
-48
lines changed

Cargo.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ rust-version = "1.56"
2121
anyhow = "1.0.37"
2222
#cap-async-std = { path = "cap-async-std", version = "^0.25.0" }
2323
cap-fs-ext = { path = "cap-fs-ext", version = "^1.0.10" }
24+
cap-net-ext = { path = "cap-net-ext", version = "^1.0.10" }
2425
cap-directories = { path = "cap-directories", version = "^1.0.10" }
2526
cap-std = { path = "cap-std", version = "^1.0.10" }
2627
cap-tempfile = { path = "cap-tempfile", version = "^1.0.10" }
@@ -32,7 +33,7 @@ libc = "0.2.100"
3233
io-lifetimes = "1.0.0"
3334

3435
[target.'cfg(not(windows))'.dev-dependencies]
35-
rustix = { version = "0.37.0", features = ["fs"] }
36+
rustix = { version = "0.37.9", features = ["fs"] }
3637

3738
[target.'cfg(windows)'.dev-dependencies]
3839
# nt_version uses internal Windows APIs, however we're only using it
@@ -72,6 +73,7 @@ arf_strings = [
7273
members = [
7374
#"cap-async-std",
7475
"cap-fs-ext",
76+
"cap-net-ext",
7577
"cap-directories",
7678
"cap-primitives",
7779
"cap-rand",

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ develops libraries to make it easy to write capability-based code, including:
2828
what's available in `std`
2929
- [`cap-rand`], which provides capability-based access to
3030
[random number generators]
31+
- [`cap-net-ext`], which provides additional network features beyond
32+
what's available in `std`
3133

3234
There is also a [`cap-std-ext`](https://crates.io/crates/cap-std-ext) crate available
3335
which is maintained independently, and includes further extension APIs for
@@ -49,6 +51,7 @@ Linux.
4951
[`cap-fs-ext`]: https://github.com/bytecodealliance/cap-std/blob/main/cap-fs-ext/README.md
5052
[`cap-time-ext`]: https://github.com/bytecodealliance/cap-std/blob/main/cap-time-ext/README.md
5153
[`cap-rand`]: https://github.com/bytecodealliance/cap-std/blob/main/cap-rand/README.md
54+
[`cap-net-ext`]: https://github.com/bytecodealliance/cap-std/blob/main/cap-net-ext/README.md
5255
[`cap_std::fs`]: https://docs.rs/cap-std/latest/cap_std/fs/index.html
5356
[`async-std`]: https://docs.rs/async-std/
5457
[standard application directories]: https://docs.rs/directories-next/

cap-async-std/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ io-extras = { version = "0.17.0", features = ["use_async_std"] }
2323
camino = { version = "1.0.5", optional = true }
2424

2525
[target.'cfg(not(windows))'.dependencies]
26-
rustix = { version = "0.37.0", features = ["fs"] }
26+
rustix = { version = "0.37.9", features = ["fs"] }
2727

2828
[features]
2929
default = []

cap-async-std/src/net/pool.rs

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,32 @@ impl Pool {
2020
}
2121
}
2222

23+
/// Add addresses to the pool.
24+
///
25+
/// # Ambient Authority
26+
///
27+
/// This function allows ambient access to any IP address.
28+
pub fn insert<A: ToSocketAddrs>(
29+
&mut self,
30+
addrs: A,
31+
ambient_authority: AmbientAuthority,
32+
) -> io::Result<()> {
33+
self.cap.insert(addrs, ambient_authority)
34+
}
35+
36+
/// Add a specific [`net::SocketAddr`] to the pool.
37+
///
38+
/// # Ambient Authority
39+
///
40+
/// This function allows ambient access to any IP address.
41+
pub fn insert_socket_addr(
42+
&mut self,
43+
addr: net::SocketAddr,
44+
ambient_authority: AmbientAuthority,
45+
) {
46+
self.cap.insert_socket_addr(addr, ambient_authority)
47+
}
48+
2349
/// Add a range of network addresses, accepting any port, to the pool.
2450
///
2551
/// Unlike `insert_ip_net`, this function grants access to any requested
@@ -64,19 +90,6 @@ impl Pool {
6490
self.cap.insert_ip_net(ip_net, port, ambient_authority)
6591
}
6692

67-
/// Add a specific [`net::SocketAddr`] to the pool.
68-
///
69-
/// # Ambient Authority
70-
///
71-
/// This function allows ambient access to any IP address.
72-
pub fn insert_socket_addr(
73-
&mut self,
74-
addr: net::SocketAddr,
75-
ambient_authority: AmbientAuthority,
76-
) {
77-
self.cap.insert_socket_addr(addr, ambient_authority)
78-
}
79-
8093
/// Creates a new `TcpListener` which will be bound to the specified
8194
/// address.
8295
///

cap-directories/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ cap-std = { path = "../cap-std", version = "^1.0.10" }
1717
directories-next = "2.0.0"
1818

1919
[target.'cfg(not(windows))'.dependencies]
20-
rustix = { version = "0.37.0" }
20+
rustix = { version = "0.37.9" }
2121

2222
[target.'cfg(windows)'.dependencies.windows-sys]
2323
version = "0.48.0"

cap-net-ext/COPYRIGHT

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Short version for non-lawyers:
2+
3+
`cap-net-ext` is triple-licensed under Apache 2.0 with the LLVM Exception,
4+
Apache 2.0, and MIT terms.
5+
6+
7+
Longer version:
8+
9+
Copyrights in the `cap-net-ext` project are retained by their contributors.
10+
No copyright assignment is required to contribute to the `cap-net-ext`
11+
project.
12+
13+
Some files include code derived from Rust's `libstd`; see the comments in
14+
the code for details.
15+
16+
Except as otherwise noted (below and/or in individual files), `cap-net-ext`
17+
is licensed under:
18+
19+
- the Apache License, Version 2.0, with the LLVM Exception
20+
<LICENSE-Apache-2.0_WITH_LLVM-exception> or
21+
<http://llvm.org/foundation/relicensing/LICENSE.txt>
22+
- the Apache License, Version 2.0
23+
<LICENSE-APACHE> or
24+
<http://www.apache.org/licenses/LICENSE-2.0>,
25+
- or the MIT license
26+
<LICENSE-MIT> or
27+
<http://opensource.org/licenses/MIT>,
28+
29+
at your option.

cap-net-ext/Cargo.toml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[package]
2+
name = "cap-net-ext"
3+
version = "1.0.10"
4+
description = "Extension traits for `TcpListener`, `Pool`, etc."
5+
authors = [
6+
"Dan Gohman <dev@sunfishcode.online>",
7+
"Jakub Konka <kubkon@jakubkonka.com>",
8+
]
9+
license = "Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT"
10+
keywords = ["filesystem"]
11+
categories = ["filesystem"]
12+
repository = "https://github.com/bytecodealliance/cap-std"
13+
edition = "2018"
14+
15+
[dependencies]
16+
cap-std = { path = "../cap-std", version = "^1.0.10" }
17+
cap-primitives = { path = "../cap-primitives", version = "^1.0.10" }
18+
rustix = { version = "0.37.9", features = ["net"] }

cap-net-ext/LICENSE-APACHE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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.

0 commit comments

Comments
 (0)