Abscissa is a microframework for building Rust applications (either CLI tools or network/web services), aiming to provide a large number of features with a minimal number of dependencies, and with a strong focus on security.
- command-line option parsing: simple declarative option parser based on gumdrop. The option parser in Abcissa contains numerous improvements which provide better UX and tighter integration with the other parts of the framework (e.g. overriding configuration settings using command-line options).
- components: Abscissa uses a component architecture (similar to an ECS)
for extensibility/composability, with a minimalist implementation that still
provides such features such as calculating dependency ordering and providing
hooks into the application lifecycle. Newly generated apps use two components
by default:
terminalandlogging. - configuration: Simple parsing of TOML configurations to
serde-parsed configuration types which can be dynamically updated at runtime. - error handling: unified error-handling subsystem with generic error type.
- logging: based on the
logto provide application-level logging. - secrets management: the (optional)
secretsmodule includes aSecrettype which derives serde'sDeserializeand can be used to represent secret values parsed from configuration files or elsewhere (e.g. credentials loaded from the environment or network requests) - terminal interactions: support for colored terminal output (with color support autodetection). Useful for Cargo-like status messages with easy-to-use macros.
- Canister: deployment utility for "distroless" containers/microVMs
- cargo-audit: audit Cargo projects for security vulnerabilities
- cargo-rpm: build RPMs out of Cargo projects
- ibc-rs: Rust implementation of Interblockchain Communication (IBC) modules and relayer
- OpenLibra: open platform for financial inclusion. Not run by Facebook.
- Sagan: observability tool for Tendermint applications
- Synchronicity: distributed build system providing BFT proofs-of-reproducibility
- Tendermint KMS: key management system for Tendermint applications
- Zebra: Rust implementation of a Zcash node
- Zerostash: Encrypted and deduplicated backups
Abscissa presently consists of three crates:
- abscissa: CLI app and application generator -
cargo install abscissa - abscissa_core: main framework library
- abscissa_derive: custom derive support - implementation detail of
abscissa_core - abscissa_tokio: support for launching Tokio runtimes within Abscissa applications
- Rust 1.36+
To generate a new Abscissa application, install the abscissa CLI utility:
$ cargo install abscissa
After installing the abscissa CLI utility using the method above, run
abscissa new <my_app> to generate a new application:
This will generate a new Abscissa application in the my_cool_app directory.
For more information, please see the Documentation.
or: "Know Your Dependencies"
One of Abscissa's primary goals is to maximize functionality while minimizing the number of dependencies. Abscissa is used in a number of high-security contexts, and as such we view each additional dependency as additional attack surface and therefore a potential liability. We have therefore been very conscientious about the dependencies we use and will not add additional dependencies without due consideration.
Here are all of Abscissa's transitive dependencies when configured with the default set of features in the application:
| # | Crate Name | Origin | License | Description |
|---|---|---|---|---|
| 1 | abscissa_core | iqlusion | Apache-2.0 | Abscissa framework |
| 2 | aho-corasick | @BurntSushi | MIT/Unlicense | Pattern-matching alg |
| 3 | ansi_term | @ogham | MIT | Terminal color libray |
| 4 | arc-swap | @vorner | Apache-2.0/MIT | Atomic swap for Arc |
| 5 | atty | @softprops | MIT | Detect TTY presence |
| 6 | autocfg | @cuviper | Apache-2.0/MIT | Rust compiler configs |
| 7 | backtrace | @alexcrichton | Apache-2.0/MIT | Capture stack traces |
| 8 | backtrace-sys | @alexcrichton | Apache-2.0/MIT | Capture stack traces |
| 9 | byteorder | @BurntSushi | MIT/Unlicense | Byte order conversions |
| 10 | canonical-path | iqlusion | Apache-2.0 | Get canonical fs paths |
| 11 | chrono | chronotope | Apache-2.0/MIT | Time/date library |
| 12 | color-backtrace | @athre0z | Apache-2.0/MIT | Rich colored backtraces |
| 13 | generational-arena | @fitzgen | MPL-2.0 | Component allocator |
| 14 | gumdrop | @Murarth | Apache-2.0/MIT | Command-line options |
| 15 | lazy_static | rust-lang | Apache-2.0/MIT | Heap-allocated statics |
| 16 | libc | rust-lang | Apache-2.0/MIT | C library wrapper |
| 17 | log | rust-lang | Apache-2.0/MIT | Logging facade library |
| 18 | matchers | @hawkw | MIT | Stream regex matching |
| 19 | maybe-uninit | @est31 | Apache-2.0/MIT | MaybeUninit compat |
| 20 | memchr | @BurntSushi | MIT/Unlicense | Optimized byte search |
| 21 | num-integer | rust-num | Apache-2.0/MIT | Integer trait |
| 22 | num-traits | rust-num | Apache-2.0/MIT | Numeric traits |
| 23 | once_cell | @matklad | Apache-2.0/MIT | Single assignment cells |
| 24 | redox_syscall | redox-os | MIT | Redox OS syscall API |
| 25 | regex | rust-lang | Apache-2.0/MIT | Regular expressions |
| 26 | regex-automata | @BurntSushi | MIT/Unlicense | Low-level regex DFAs |
| 27 | regex-syntax | rust-lang | Apache-2.0/MIT | Regex syntax impl |
| 28 | rustc-demangle | @alexcrichton | Apache-2.0/MIT | Symbol demangling |
| 29 | secrecy | iqlusion | Apache-2.0 | Secret-keeping types |
| 30 | semver | @steveklabnik | Apache-2.0/MIT | Semantic versioning |
| 31 | semver-parser | @steveklabnik | Apache-2.0/MIT | Parser for semver spec |
| 32 | serde | serde-rs | Apache-2.0/MIT | Serialization framework |
| 33 | sharded-slab | @hawkw | MIT | Concurrent slab allocator |
| 34 | signal-hook | @vorner | Apache-2.0/MIT | Unix signal handling |
| 35 | signal-hook-registry | @vorner | Apache-2.0/MIT | Unix signal registry |
| 36 | smallvec | servo | Apache-2.0/MIT | Optimized small vectors |
| 37 | termcolor | @BurntSushi | MIT/Unlicense | Terminal color support |
| 38 | thread_local | @Amanieu | Apache-2.0/MIT | Per-object thread local |
| 39 | time | rust-lang | Apache-2.0/MIT | Time/date library |
| 40 | toml | @alexcrichton | Apache-2.0/MIT | TOML parser library |
| 41 | tracing | tokio-rs | MIT | App tracing / logging |
| 42 | tracing-core | tokio-rs | MIT | App tracing / logging |
| 43 | tracing-log | tokio-rs | MIT | log compatibility |
| 44 | tracing-subscriber | tokio-rs | MIT | Tracing subscribers |
| 45 | utf8-ranges | @BurntSushi | MIT/Unlicense | UTF-8 codepoint ranges |
| 46 | winapi§ | @retep998 | Apache-2.0/MIT | Windows FFI bindings |
| 47 | winapi-util | @BurntSushi | MIT/Unlicense | Safe winapi wrappers |
| 48 | wincolor | @BurntSushi | MIT/Unlicense | Windows console color |
| 49 | zeroize | iqlusion | Apache-2.0/MIT | Zero out sensitive data |
| # | Crate Name | Origin | License | Description |
|---|---|---|---|---|
| 1 | abscissa_derive | iqlusion | Apache-2.0 | Abscissa custom derive |
| 2 | cc | @alexcrichton | Apache-2.0/MIT | C/C++ compiler wrapper |
| 3 | cfg-if | @alexcrichton | Apache-2.0/MIT | If-like #[cfg] macros |
| 4 | darling | @TedDriggs | MIT | Nifty attribute parser |
| 5 | darling_core | @TedDriggs | MIT | Attribute parser core |
| 6 | darling_macro | @TedDriggs | MIT | Attribute parser macros |
| 7 | fnv | @alexcrichton | Apache-2.0/MIT | Fast hash function |
| 8 | gumdrop_derive | @Murarth | Apache-2.0/MIT | Command-line options |
| 9 | ident_case | @TedDriggs | Apache-2.0/MIT | Case conversion utils |
| 10 | proc-macro2 | @alexcrichton | Apache-2.0/MIT | Shim for Macros 2.0 API |
| 11 | quote | @dtolnay | Apache-2.0/MIT | Rust AST to token macro |
| 12 | serde_derive | serde-rs | Apache-2.0/MIT | serde custom derive |
| 13 | strsim | @dguo | MIT | String similarity utils |
| 14 | syn | @dtolnay | Apache-2.0/MIT | Rust source code parser |
| 15 | synstructure | @mystor | Apache-2.0/MIT | syn structure macros |
| 16 | thiserror | @dtolnay | Apache-2.0/MIT | Error custom derive |
| 17 | tracing-attributes | tokio-rs | MIT | App tracing / logging |
| 18 | unicode-xid | unicode-rs | Apache-2.0/MIT | Identify valid Unicode |
| 19 | wait-timeout | @alexcrichton | Apache-2.0/MIT | Timeouts for waitpid |
The table below should help answer questions as to why a particular crate is an Abscissa dependency and whether or not it is optional. Abscissa uses cargo features to allow parts of it you aren't using to be easily disabled, so you only compile the parts you need.
- §
winapiis a facade for either winapi-i686-pc-windows-gnu or winapi-x86_64-pc-windows-gnu which aren't explicitly listed for brevity and are only required on Windows platforms.
A1: The word "abscissa" is the key to the Kryptos K2 panel.
A2: Imagine you're A-B testing a couple of scissors... with attitude.
The main way to test framework changes is by generating an application with Abscissa's built-in application generator and running tests against the generated application (also rustfmt, clippy).
To generate a test application and test it automatically, you can simply do:
$ cargo test
However, when debugging test failures against a generated app, it's helpful to know how to drive the app generation and testing process manually. Below are instructions on how to do so.
If you've already run:
$ git clone https://github.com/iqlusioninc/abscissa/
...and are inside the abscissa directory and want to test your changes,
you can generate an application by running the following command:
$ cargo run -- new /tmp/example_app --patch-crates-io='abscissa = { path = "$PWD" }'
This will generate a new Abscissa application in /tmp/example_app which
references your local copy of Abscissa.
After that, change directory to the newly generated app and run the tests to ensure things are still working (the tests, along with rustfmt and clippy are run as part of the CI process):
$ cd /tmp/example_app # or 'pushd /tmp/example_app' and 'popd' to return
$ cargo test
$ cargo fmt -- --check # generated app is expected to pass rustfmt
$ cargo clippy
We abide by the Contributor Covenant and ask that you do as well.
For more information, please see CODE_OF_CONDUCT.md.
The abscissa crate is distributed under the terms of the Apache License (Version 2.0).
Copyright © 2018-2020 iqlusion
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
If you are interested in contributing to this repository, please make sure to read the CONTRIBUTING.md and CODE_OF_CONDUCT.md files first.