Skip to content

Latest commit

 

History

History
49 lines (42 loc) · 1.91 KB

README.md

File metadata and controls

49 lines (42 loc) · 1.91 KB
Raw

openkeystore

Smart Card/TEE Key Store and Credential Provisioning System

This project defines SKS (Secure Key Store) which can hold X.509 certificates and symmetric keys as well as associated attributes such as logotypes, key ACLs and URLs:
https://cyberphone.github.io/doc/security/sks-api-arch.pdf

The project also defines KeyGen2 which is a credential provisioning and management system for SKS:
https://cyberphone.github.io/doc/security/keygen2.html

The JSON library supports a clear text signature system called JCS:
https://cyberphone.github.io/doc/security/jcs.html
as well as a "matching" encryption scheme coined JEF:
https://cyberphone.github.io/doc/security/jef.html

Requirements

  • Java SDK Version 8
  • Ant 1.9.4 or later
  • The projects are being developed using Eclipse but there's no dependence on Eclipse.

Currently only the "library" and "resources" projects are suitable public use. To create the openkeystore library, perform the following steps:

$ cd library
$ ant
$ ant doc
$ ant testjson

API

Now you should have a file library/dist/webpki.org-libext-1.00.jar which implements the API described in library/overview-summary.html.

Proof of Concept Implementation

There also is an Android proof-of-concept implementation which allows you to test provisioning and then using provisioned keys for authentication:
https://play.google.com/store/apps/details?id=org.webpki.mobile.android

Android JSON, JCS, and JEF support

To create a source distribution for Android perform:

$ cd library
$ ant android-json

Now you should have a file library/dist/webpki.android.json.zip which can be imported in an Android project. For use with a larger base of Android devices the Spongycastle library is recommended:
https://rtyley.github.io/spongycastle/

An Android demo/test project is available at:
https://github.com/cyberphone/android-json