|
1 | 1 | # Parsec Java Client
|
2 | 2 |
|
3 |
| -To enabled Parsec support in the Java Ecosystem, this repository contains multiple implementaiton(s) of Java Client that consumes the API Providers by the Parsec Service. Using this library is possible in two ways, as a Basic Java Client and/or as a Native Java JCA Interface. |
| 3 | +This repository contains a Java Client and a [JCA provider](https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html) for Parsec. The client exposes the [PSA Crypto API](https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/PSA_Cryptography_API_Specification.pdf) to Java Applications and the JCA Provider allows existing applications that employ JCA to switch to Parsec. |
| 4 | + |
| 5 | +*Note*: this client is at an early stage of development and not yet ready for production use. We welcome contributions! |
4 | 6 |
|
5 | 7 | ## In this repository
|
6 | 8 |
|
7 |
| -The following are the |
| 9 | +The repository contains the following packages: |
8 | 10 |
|
9 |
| -- parsec-client-java : Basic Client |
10 |
| -- parsec-interface-java: wrapper |
11 |
| -- parsec-jca-java: This is the native JCA (Java Cryptograpy Adapter..) |
12 |
| -- parsec-protobuf-java: This is submodule of the PArsec Protobuf where java classes are generated |
13 |
| -- parsec-testcontainers: collection of Docker test containers to test the use of Java Client |
| 11 | +- parsec-client-java : PSA Crypto API Client |
| 12 | +- parsec-jca-java: JCA Provider |
| 13 | +- parsec-interface-java: Private wrapper for protobuf classes and socket communication |
| 14 | +- parsec-protobuf-java: Java Protobuf classes (generated) |
| 15 | +- parsec-testcontainers: Collection of Docker test containers for development & testing |
14 | 16 |
|
15 | 17 | # How to use this library
|
16 |
| -Here is explain how to use the Parsec Java-Client library in your application |
| 18 | +TODO |
17 | 19 |
|
18 | 20 | # How to develop the Parsec Java Client
|
19 |
| -If you'd like to get started in developing parsec further, we explain how to get started and the design behind the support for parsec in java |
| 21 | +TODO |
20 | 22 |
|
21 | 23 | # Example Implementations
|
22 |
| -There are a number of example implementations of both the basic java client and JCA client along with a demo (seperate repository) |
23 |
| -Both the tests and workshop demo cover the basic functionality of Parsec that address the majority of use cases, the following |
| 24 | +There are a number of example implementations of both the basic java client and JCA provider along with a demo (separate repository) |
| 25 | +Both the tests and workshop demo cover the basic functionality of the current implementation: |
24 | 26 |
|
25 | 27 | - Parsec JCA Tests [**Link**](/parsec-jca-test)
|
26 | 28 | - Parsec Test Containers [**Link**](/parsec-testcontainers)
|
|
0 commit comments