Skip to content

Commit 8158147

Browse files
author
tom zhou
committed
fixed README.md
1 parent 736ef04 commit 8158147

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,42 @@
1-
tweetnacl-java
2-
==============
1+
rewrite tweetnacl.c in pure Java
32

4-
Porting TweetNacl in Java
3+
4+
### API/Usage
5+
6+
#### Public key authenticated encryption
7+
8+
* get key pair: Box.KeyPair kp = Box.keyPair(), kp = Box.keyPair_fromSecretKey(sk)
9+
* new Box object: Box box = new Box(theirPublicKey, mySecretKey, Nonce);
10+
* encryption: cipher = box.box(message);
11+
* decryption: message = box.open(cipher);
12+
* Nonce MUST be unique for ever message passed between same peers
13+
14+
15+
#### Secret key authenticated encryption
16+
17+
* get shared key: crypto random, what you have
18+
* new SecretBox object: SecretBox sbox = new SecretBox(sharedKey, Nonce);
19+
* encryption: cipher = sbox.box(message);
20+
* decryption: message = sbox.open(cipher);
21+
* Nonce MUST be unique for ever message passed between same peers
22+
23+
24+
### Signature
25+
26+
* get key pair: Signature.KeyPair kp = Signature.keyPair(), kp = Signature.keyPair_fromSecretKey(sk);
27+
* new Signature object: Signature sig = new Signature(theirPublicKey, mySecretKey);
28+
* sign: signedMessage = sig.sign(message);
29+
* verify: message = sig.open(signedMessage);
30+
* Nonce MUST be unique for ever message passed between same peers
31+
32+
33+
### Hash
34+
35+
* generate SHA-512: byte [] tag = Hash.sha512(message);
36+
37+
38+
### Refer to com.iwebpp.crypto.tests for details
539

640

741
### License MIT
42+

0 commit comments

Comments
 (0)