io.nessus.ipfs

Interface ContentManager

All Known Implementing Classes:

DefaultContentManager

public interface ContentManager

Encryption ---------- An RSA key pair is derived from the Bob's private key. The public RSA key is registered on the blockchain. The RSA key pair is indempotent for the same user. An AES secret is derived from Bob's private key and the content id. The AES secret is encrypted with Mary's public RSA key, which results in an encryption token. The encryption token is recorded in the ipfs file header. An AES initialization vector (IV) is derived from Bob's private key and the content id. The file content as encrypted with the AES secret and the deterministic IV. The encrypted file (which consists of header and body) is added to IPFS. The resulting IPFS content id (CID) is recorded on the blockchain. The CID for the encrypted content is indempotent for the same user and content. Decryption ---------- Mary obtains an IPFS content id from her unspent transaction outputs (UTXO). An IPFS get operation fetches the encrypted file (i.e. header + body) Mary obtains the encryption token from the file header. The encryption token is decrypted with the Mary's private RSA key, which results in the AES secret. Mary decrypts the file body with the so obtained AES secret. The plain content is stored in Mary's workspace. KEEP IN SYNC WITH IpfsWorkflowTest

Method Summary

Modifier and Type	Method and Description
FHandle	addIpfsContent(io.nessus.Wallet.Address owner, java.nio.file.Path srcPath) Add content to IPFS from local file system.
FHandle	addIpfsContent(io.nessus.Wallet.Address owner, java.nio.file.Path dstPath, java.io.InputStream input) Add content to IPFS.
FHandle	addIpfsContent(io.nessus.Wallet.Address owner, java.nio.file.Path dstPath, java.net.URL srcUrl) Add content to IPFS.
AHandle	findAddressRegistation(io.nessus.Wallet.Address addr, java.lang.Long timeout) Find the public encyption key for a given address.
java.util.List<FHandle>	findIpfsContent(io.nessus.Wallet.Address owner, java.lang.Long timeout) Find registered IPFS content for a given address.
java.util.List<FHandle>	findLocalContent(io.nessus.Wallet.Address owner) Find local content for a given address.
FHandle	findLocalContent(io.nessus.Wallet.Address owner, java.nio.file.Path path) Find local content for a given address and path.
io.nessus.Blockchain	getBlockchain() Get the Blockchain
io.nessus.ipfs.client.IPFSClient	getIPFSClient() Get the IPFS client
FHandle	getIpfsContent(io.nessus.Wallet.Address owner, io.ipfs.multihash.Multihash cid, java.nio.file.Path path, java.lang.Long timeout) Get content from IPFS.
java.io.InputStream	getLocalContent(io.nessus.Wallet.Address owner, java.nio.file.Path path) Show content of a plain file from local storage.
AHandle	registerAddress(io.nessus.Wallet.Address addr) Create the public encyption key for a given address.
boolean	removeLocalContent(io.nessus.Wallet.Address owner, java.nio.file.Path path) Remove a plain file content from local storage.
FHandle	sendIpfsContent(io.nessus.Wallet.Address owner, io.ipfs.multihash.Multihash cid, io.nessus.Wallet.Address target, java.lang.Long timeout) Send content to a target address via IPFS.
AHandle	unregisterAddress(io.nessus.Wallet.Address addr) Unregister the public encyption key for a given address.
java.util.List<io.ipfs.multihash.Multihash>	unregisterIpfsContent(io.nessus.Wallet.Address owner, java.util.List<io.ipfs.multihash.Multihash> cids) Unregister a IPFS content.

Method Detail

getBlockchain

io.nessus.Blockchain getBlockchain()

Get the Blockchain

getIPFSClient

io.nessus.ipfs.client.IPFSClient getIPFSClient()

Get the IPFS client

registerAddress

AHandle registerAddress(io.nessus.Wallet.Address addr)
                 throws java.security.GeneralSecurityException,
                        java.io.IOException

Create the public encyption key for a given address.

Throws:

java.security.GeneralSecurityException

java.io.IOException

findAddressRegistation

AHandle findAddressRegistation(io.nessus.Wallet.Address addr,
                               java.lang.Long timeout)

Find the public encyption key for a given address.

unregisterAddress

AHandle unregisterAddress(io.nessus.Wallet.Address addr)

Unregister the public encyption key for a given address.

addIpfsContent

FHandle addIpfsContent(io.nessus.Wallet.Address owner,
                       java.nio.file.Path dstPath,
                       java.net.URL srcUrl)
                throws java.io.IOException,
                       java.security.GeneralSecurityException

Add content to IPFS.

Throws:

java.io.IOException

java.security.GeneralSecurityException

addIpfsContent

FHandle addIpfsContent(io.nessus.Wallet.Address owner,
                       java.nio.file.Path dstPath,
                       java.io.InputStream input)
                throws java.io.IOException,
                       java.security.GeneralSecurityException

Add content to IPFS.

Throws:

java.io.IOException

java.security.GeneralSecurityException

addIpfsContent

FHandle addIpfsContent(io.nessus.Wallet.Address owner,
                       java.nio.file.Path srcPath)
                throws java.io.IOException,
                       java.security.GeneralSecurityException

Add content to IPFS from local file system.

Throws:

java.io.IOException

java.security.GeneralSecurityException

getIpfsContent

FHandle getIpfsContent(io.nessus.Wallet.Address owner,
                       io.ipfs.multihash.Multihash cid,
                       java.nio.file.Path path,
                       java.lang.Long timeout)
                throws java.io.IOException,
                       java.security.GeneralSecurityException

Get content from IPFS.

Throws:

java.io.IOException

java.security.GeneralSecurityException

findIpfsContent

java.util.List<FHandle> findIpfsContent(io.nessus.Wallet.Address owner,
                                        java.lang.Long timeout)
                                 throws java.io.IOException

Find registered IPFS content for a given address.

Throws:

java.io.IOException

sendIpfsContent

FHandle sendIpfsContent(io.nessus.Wallet.Address owner,
                        io.ipfs.multihash.Multihash cid,
                        io.nessus.Wallet.Address target,
                        java.lang.Long timeout)
                 throws java.io.IOException,
                        java.security.GeneralSecurityException

Send content to a target address via IPFS.

Throws:

java.io.IOException

java.security.GeneralSecurityException

unregisterIpfsContent

java.util.List<io.ipfs.multihash.Multihash> unregisterIpfsContent(io.nessus.Wallet.Address owner,
                                                                  java.util.List<io.ipfs.multihash.Multihash> cids)
                                                           throws java.io.IOException

Unregister a IPFS content.

Throws:

java.io.IOException

getLocalContent

java.io.InputStream getLocalContent(io.nessus.Wallet.Address owner,
                                    java.nio.file.Path path)
                             throws java.io.IOException

Show content of a plain file from local storage.

Throws:

java.io.IOException

findLocalContent

java.util.List<FHandle> findLocalContent(io.nessus.Wallet.Address owner)
                                  throws java.io.IOException

Find local content for a given address.

Throws:

java.io.IOException

findLocalContent

FHandle findLocalContent(io.nessus.Wallet.Address owner,
                         java.nio.file.Path path)
                  throws java.io.IOException

Find local content for a given address and path.

Throws:

java.io.IOException

removeLocalContent

boolean removeLocalContent(io.nessus.Wallet.Address owner,
                           java.nio.file.Path path)
                    throws java.io.IOException

Remove a plain file content from local storage.

Throws:

java.io.IOException