Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Codespell fixes #3710

Merged
merged 9 commits into from
Oct 22, 2022
Merged
Prev Previous commit
Next Next commit
docs: codespell documentation/
  • Loading branch information
jtmoon79 authored and mrinalwadhwa committed Oct 22, 2022
commit d803e756104d77ad2e65abc2573c2b2fb1179296
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ Credential contains identity of the sender, a set of attributes this sender is a
### Credential based attribute acceptance implementation

To accept attributes from a credential, the accepting endpoint will need to trust a credential authority and be able to verify credential signature.
This is implemented by posessing the credential authority identity, which contains the public key used to sign credentials.
This is implemented by possessing the credential authority identity, which contains the public key used to sign credentials.

The attribute acceptance works as following:

- Receive a credential from an identity
- Verify credential signature and identity using credential verifier service
- Receive attribute set from the verifier service
- Save attribute set to local cache assiciated with the sender identity
- Save attribute set to local cache associated with the sender identity


### Attribute sets and expiration

Posession of attributes by certain identity may change over time, this means we need to remove attributes from the attribute storage for this identity at some point.
Possession of attributes by certain identity may change over time, this means we need to remove attributes from the attribute storage for this identity at some point.
This can be done by having attribute expiration time and removing the attributes once they expired.

Expiration time is controlled by the credential authority and communicated in a credential.
Expand All @@ -47,7 +47,7 @@ A group of attributes presented in a credential with their expiry is called attr

**Current implementation of attribute storage allows to store one attribute set per identity.**

**If the same identity presents a new credential - old attribute set is overriden by a new one.**
**If the same identity presents a new credential - old attribute set is overridden by a new one.**


### Credential exchange
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The public API of Rust's standard library is split into 3 parts.
- If no `#[global_allocator]` is configured, then `libstd` will provide one based on the OS's default allocator.
- In the rare cases where `libstd` supports a target without a system-provided allocator, `libstd` will provide a default written in Rust (currently, it uses a Rust [port of `dlmalloc`](https://crates.io/crates/dlmalloc) for these situations).

As you may note, these are analagous to the three configurations we wish to support, but there is an important difference:
As you may note, these are analogous to the three configurations we wish to support, but there is an important difference:

We should do not adopt the restriction that `libcore` and `liballoc` has around target-specific checks and `cfg`s and such. We favor practicality over purity, and without this, we would be completely unable to provide useful functionality for embedded environments.

Expand Down
2 changes: 1 addition & 1 deletion documentation/architecture/workers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ impl Worker for MyWorker {
type Context = Context;
type Message = MyMessage;

fn intialize(&mut self, ctx: &mut Context) -> Result<()> {
fn initialize(&mut self, ctx: &mut Context) -> Result<()> {
println!("Starting worker {}", ctx.address())
Ok(())
}
Expand Down
2 changes: 1 addition & 1 deletion documentation/use-cases/run-ockam-on-riscv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ building Rust executables for RISC-V is the presence of a RISC-V linker, such as
- For Debian: `apt-get install gcc-riscv64-linux-gnu`
- For MacOS: `brew tap riscv/riscv && brew install --cc=gcc-10 riscv-tools`

In your `ockam_rv` project, create a `.cargo/config.toml` file. In this file, we specify that we're builing for RISC-V
In your `ockam_rv` project, create a `.cargo/config.toml` file. In this file, we specify that we're building for RISC-V
and also configure the location of the linker.


Expand Down