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

added text to demo and github workflow for npm-publishing #10

Merged
merged 5 commits into from
Dec 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages

name: npm-publish

on:
release:
types: [created]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# Setup .npmrc file to publish to npm
- uses: actions/setup-node@v2
with:
node-version: '12.x'
registry-url: 'https://registry.npmjs.org'
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
46 changes: 40 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>node-onlykey</title>
<title>node-onlykey demonstration</title>

<link href="./libs/bootstrap/css/bootstrap.min.css" rel="stylesheet">

Expand All @@ -17,7 +17,7 @@

<body>
<nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
<a class="navbar-brand" href="./">node-onlykey</a>
<a class="navbar-brand" href="./">node-onlykey demonstration</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
Expand All @@ -32,11 +32,45 @@
</nav>

<main role="main" class="container-fluid" id="main-container">

<h2>Welcome to Onlykey's 3rd Party demonstration.</h2><hr/>
Here we show you how to encrypt and decrypt using shared keys.<br/>
For shared key cryptography to work, the sender and the recipient of a message must both have the same key, which they must keep secret from everybody else.<br/>
The sender uses the shared key to encrypt a message, and then sends the ciphertext message to the recipient.<br/>
When the ciphertext message arrives, the recipient uses the identical shared key to decrypt the message.
<br/>
<hr/>
With Onlykey, We offer 2 types of Key Types(P256R1 and CURVE25519) that can generate shared secret keys. First by generating a Unique Public Key that is sent to sender and a Unique Public Key received from the recipient.<br/>
It's important to understand that all keys generated with Onlykey are unique per Domain in combination with Additional Data.<br/>
Additional Data Changes the Public and Private Keys to allow a unlimited amount of keys to generate shared secrets per domain.<br/>
Generating keys with identical Additional Data on a different domain will result in a different key.
<hr/>
In addition to Generating keys. There is a optional physical human press interaction. Securing rogue access to shared keys.<br/>
This allows developers to ensure secure access in special scenarios.
<hr/>
Onlykey's Key Generation is Transparent, Keys are not marked when being generated by Onlykey. This alows Anonymity from other users to hide where the key is being generated or stored.
<hr/>
<!--<a id="NACL.js" href="javascript:void(0);" class="btn btn-primary startTestType">nacl.js</a><br/><br/>-->
<a id="P256R1" href="javascript:void(0);" class="btn btn-primary startTestType">P256R1</a><br/><br/>
<a id="P256R1-enc" href="javascript:void(0);" class="btn btn-primary startTestType">P256R1 (REQ_PRESS)</a><br/><br/>
<a id="CURVE25519" href="javascript:void(0);" class="btn btn-primary startTestType">CURVE25519</a><br/><br/>
<a id="CURVE25519-enc" href="javascript:void(0);" class="btn btn-primary startTestType">CURVE25519 (REQ_PRESS)</a><br/><br/>
<div>
<h3>P256R1</h3>
<div class="d-flex justify-content-center">
<div><a id="P256R1" href="javascript:void(0);" class="btn btn-primary startTestType">P256R1</a>&nbsp;&nbsp;<a id="P256R1-enc" href="javascript:void(0);" class="btn btn-primary startTestType">P256R1 (REQ_PRESS)</a></div>
</div>
</div>

<hr/>
<div>
<h3>CURVE25519</h3>
<div class="d-flex justify-content-center">
<div><a id="CURVE25519" href="javascript:void(0);" class="btn btn-primary startTestType">CURVE25519</a>&nbsp;&nbsp;<a id="CURVE25519-enc" href="javascript:void(0);" class="btn btn-primary startTestType">CURVE25519 (REQ_PRESS)</a><br/><br/></div>
</div>
</div>
<hr/>
Source and Documentation: <a href="https://github.com/trustcrypto/node-onlykey">https://github.com/trustcrypto/node-onlykey</a>
<br/>
Report and issue here: <a href="https://github.com/trustcrypto/node-onlykey/issues">https://github.com/trustcrypto/node-onlykey/issues</a>
<br/>
<div class="col-sm text-center"><a href="https://crp.to/">CryptoTrust LLC</a> © 2022</div>
</main>

<script src="./libs/jquery.js"></script>
Expand Down