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.

Sign up for GitHub

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

A few more README updates including fixes for broken doc links #141

Merged
merged 5 commits into from
Apr 8, 2020
Merged

A few more README updates including fixes for broken doc links #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
874b5d6
- A few adjustments to wording
paulhowardarm Apr 7, 2020
50292aa
Missing pieces of previous commit.
paulhowardarm Apr 7, 2020
e3b5d13
- A few adjustments to wording
paulhowardarm Apr 7, 2020
a715bde
Missing pieces of previous commit.
paulhowardarm Apr 7, 2020
0b8e3da
Merge branch 'master' of https://github.com/paulhowardarm/parsec
paulhowardarm Apr 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions PARTNERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

(To appear here)

**Note**: Arm is contributing to Parsec as part of [Project Cassini](https://www.arm.com/-/media/global/solutions/artificial-intelligence/Project_Cassini.pdf).

# Adopters and Industry Partners

(To appear here)
30 changes: 16 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,17 @@

# Welcome To PARSEC

**PARSEC** is the **P**latform **A**bst**R**action for **SEC**urity, a new open-source initiative
**PARSEC** is the **P**latform **A**bst**R**action for **SEC**urity, an open-source initiative
to provide a common API to hardware security and cryptographic services in a platform-agnostic way. This abstraction layer keeps workloads decoupled from physical platform details, enabling cloud-native delivery flows within the data center and at the edge.

<p align="center">
<img src="./doc/images/parsec/ParsecConceptDiagram.png" alt="Parsec Concept Diagram"/>
</p>

Read the Parsec documentation [online](https://parallaxsecond.github.io/parsec-book/).
Read the Parsec documentation [**online**](https://parallaxsecond.github.io/parsec-book/).

Read the whitepaper [Security for the Infrastructure Edge](https://www.arm.com/-/media/global/people/Security-For-The-Infrastructure-Edge-White-paper-NDA).
Read the whitepaper [**Security for the Infrastructure Edge**](https://www.arm.com/-/media/global/people/Security-For-The-Infrastructure-Edge-White-paper-NDA).

**Note**: Arm is contributing to Parsec as part of [Project Cassini](https://www.arm.com/-/media/global/solutions/artificial-intelligence/Project_Cassini.pdf).

# Why PARSEC?

Expand All @@ -49,18 +48,22 @@ Use Parsec when you need:

The value proposition of Parsec is that it provides the following:

- **Abstraction** – a common API that is truly agnostic and based on modern cryptographic principles, grounded in the [Platform Security Architecture](https://www.arm.com/why-arm/architecture/platform-security-architecture)
- **Abstraction** – a common API that is truly agnostic and based on modern cryptographic principles
- **Mediation** – security as a microservice, brokering access to the hardware and providing isolated key stores in a multi-tenant environment
- **Ergonomics** – a client library ecosystem that brings the API to the fingertips of developers in any programming language: “easy to consume, hard to get wrong”
- **Openness** – an open-source project inviting contributions to enhance the ecosystem both within the service and among its client libraries

# Maintainers

PARSEC is a collaborative project. The current list of the individuals and organizations who maintain this project can be found [**here**](./MAINTAINERS.toml).

# Partner Organizations

See who is [using and contributing to PARSEC](./PARTNERS.md).
See who is [**using and contributing to PARSEC**](./PARTNERS.md).

# Disclaimer

Parsec is a new open source project and is under development. This code repository is being made
Parsec is a new open source project and is under active development. This code repository is being made
available so that the developer community can learn and give feedback about the new interfaces and the concepts of platform-agnostic security.
The implementation that is provided is suitable for exploratory testing and experimentation only.
This test implementation does not offer any tangible security benefits and therefore is not
Expand All @@ -70,7 +73,7 @@ Contributions from the developer community are welcome. Please refer to the cont

# Example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a note: when the Rust client is ready it would be nice to put it here in the example section instead of the Test client 😃


Launch the Parsec service with Mbed Crypto as the only provider (using the default configuration):
Launch the Parsec service with a single software-based provider (using the default configuration):
```bash
$ git clone https://github.com/parallaxsecond/parsec.git
$ cd parsec
Expand All @@ -90,12 +93,12 @@ let signature = client.sign(key_name,
.unwrap();
```

Check the [user](https://parallaxsecond.github.io/parsec-book/user_guides/) and [developer](https://parallaxsecond.github.io/parsec-book/dev_guides/) guides for more info on building, installing, testing and using Parsec!
Check the [**user**](https://parallaxsecond.github.io/parsec-book/parsec_users.html), [**client developer**](https://parallaxsecond.github.io/parsec-book/parsec_client/index.html) and [**service developer**](https://parallaxsecond.github.io/parsec-book/parsec_service/index.html) guides for more information on building, installing, testing and using Parsec!

# Community Channel and Meetings

Come and talk to us in [our Slack channel](https://app.slack.com/client/T0JK1PCN6/CPMQ9D4H1)!
[Here](http://dockr.ly/slack) is how to join the workspace.
Come and talk to us in our[**Slack channel**](https://app.slack.com/client/T0JK1PCN6/CPMQ9D4H1)!
[**Here**](http://dockr.ly/slack) is how to join the workspace.

Also join the [**biweekly meeting**](https://calendar.google.com/calendar?cid=ZG9ja2VyLmNvbV9xcHAzbzl2aXBhbmE0NGllcmV1MjlvcHZkNEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t)
with Parsec maintainers and community members.
Expand All @@ -105,8 +108,7 @@ discuss features, integrations, issues, and roadmap. We look forward to seeing y
# Contributing

We would be happy for you to contribute to Parsec! Check the [**Contributing**](CONTRIBUTING.md)
file to know more about the contribution process. For a list of current contributors, check [here](CONTRIBUTORS.md).
Check the [open issues](https://github.com/orgs/parallaxsecond/projects/1) on the board if you
file to know more about the contribution process. For a list of current contributors, check [**here**](CONTRIBUTORS.md). Check the [**open issues**](https://github.com/orgs/parallaxsecond/projects/1) on the board if you
need any ideas 🙂!

# License
Expand Down Expand Up @@ -141,4 +143,4 @@ This project uses the following third party crates:
* version (MIT and Apache-2.0)

This project uses the following third party libraries:
* [Mbed Crypto](https://github.com/ARMmbed/mbed-crypto) (Apache-2.0)
* [**Mbed Crypto**](https://github.com/ARMmbed/mbed-crypto) (Apache-2.0)