io.nessus.ipfs.jaxrs

Interface JAXRSEndpoint

All Known Implementing Classes:

JAXRSClient, JAXRSResource

@Path(value="/")
public interface JAXRSEndpoint

Method Summary

Modifier and Type	Method and Description
SFHandle	addIpfsContent(java.lang.String owner, java.lang.String path, java.io.InputStream input) Add IPFS content from the given input stream.
SFHandle	addIpfsContent(java.lang.String owner, java.lang.String path, java.net.URL srcURL) Add IPFS content from the given path or URL.
java.util.List<SAHandle>	findAddressInfo(java.lang.String label, java.lang.String addr) Get address registration details.
java.util.List<SFHandle>	findIpfsContent(java.lang.String owner, java.lang.Long timeout) Find IPFS content for a given owner address.
java.util.List<SFHandle>	findLocalContent(java.lang.String owner, java.lang.String path) Find local content for a given owner.
SFHandle	getIpfsContent(java.lang.String owner, java.lang.String cid, java.lang.String path, java.lang.Long timeout) Get IPFS content by id.
java.io.InputStream	getLocalContent(java.lang.String owner, java.lang.String path) Gets local content for a given owner.
SAHandle	registerAddress(java.lang.String addr) Register the given address with the system.
boolean	removeLocalContent(java.lang.String owner, java.lang.String path) Remove local content for a given owner.
SFHandle	sendIpfsContent(java.lang.String owner, java.lang.String cid, java.lang.String target, java.lang.Long timeout) Send IPFS content to a target address.
SAHandle	unregisterAddress(java.lang.String addr) Unegister the given address from the system.
java.util.List<java.lang.String>	unregisterIpfsContent(java.lang.String owner, java.util.List<java.lang.String> cids) Unregister IPFS content.

Method Detail

registerAddress

@GET
 @Path(value="/regaddr")
 @Produces(value="application/json")
SAHandle registerAddress(@QueryParam(value="addr")
                                                                                            java.lang.String addr)
                                                                                     throws java.security.GeneralSecurityException,
                                                                                            java.io.IOException

Register the given address with the system. This records a data transaction on the blockchain which published the public IPFS content encryption key for the given address. The cost for this transaction is 10 x dust for the configured network, which is paid to the given address and hence creating an a new unspent transaction output (UTXO). This UTXO is then locked to prevent accidetal spending. Example: curl -f http://192.168.178.20:8081/nessus/regaddr?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB { "label": "Bob", "address": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "balance": 49.99992040, "encKey": "MDYwEAYHKoZIzj0CAQYFK4EEABwDIgAExY/IQsYFnzFS8/QdFyCU5RNK7OkK79Fu7hvOKearR+4=", "watchOnly": false }

Returns:

A handle to the registered address

Throws:

java.security.GeneralSecurityException

java.io.IOException

findAddressInfo

@GET
 @Path(value="/addrinfo")
 @Produces(value="application/json")
java.util.List<SAHandle> findAddressInfo(@QueryParam(value="label")
                                                                                                             java.lang.String label,
                                                                                                             @QueryParam(value="addr")
                                                                                                             java.lang.String addr)
                                                                                                      throws java.io.IOException

Get address registration details. Example: curl -f http://192.168.178.20:8081/nessus/addrinfo?label=Bob [{ "label": "Bob", "address": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "balance": 49.99992040, "encKey": "MDYwEAYHKoZIzj0CAQYFK4EEABwDIgAExY/IQsYFnzFS8/QdFyCU5RNK7OkK79Fu7hvOKearR+4=", "watchOnly": false }]

Parameters:

label - An optional filter for a specific label

addr - An optional filter for a specific address

Returns:

A list of address handles

Throws:

java.io.IOException

unregisterAddress

@GET
 @Path(value="/rmaddr")
 @Produces(value="application/json")
SAHandle unregisterAddress(@QueryParam(value="addr")
                                                                                             java.lang.String addr)
                                                                                      throws java.io.IOException

Unegister the given address from the system. The UTXO that holds the registrion for the given address is unlocked and then spent to the given address. The system no longer sees the transaction that holds the public IPFS content encryption key. Example: curl -f http://192.168.178.20:8081/nessus/rmaddr?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB { "label": "Bob", "address": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "balance": 49.99992040, "encKey": "MDYwEAYHKoZIzj0CAQYFK4EEABwDIgAExY/IQsYFnzFS8/QdFyCU5RNK7OkK79Fu7hvOKearR+4=", "watchOnly": false }

Returns:

A handle to the unregistered address

Throws:

java.io.IOException

addIpfsContent

@POST
 @Path(value="/addipfs")
 @Produces(value="application/json")
SFHandle addIpfsContent(@QueryParam(value="addr")
                                                                                            java.lang.String owner,
                                                                                            @QueryParam(value="path")
                                                                                            java.lang.String path,
                                                                                            java.io.InputStream input)
                                                                                     throws java.io.IOException,
                                                                                            java.security.GeneralSecurityException

Add IPFS content from the given input stream. The owner address must have been registered with the system so that the content can be properly encrypted before it is added to IPFS. Encrypted content must be given a unique path in the owner's namespace. Example: echo "Hello World" > test.txt curl --request POST --data @test.txt http://192.168.178.20:8081/nessus/addipfs?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB\&path=test.txt { "cid": "Qme7mLoshqb8E8szmebWqiY8o1UbMAYcWL1b3YdTyPv6Ds", "owner": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "txId": "2fd2bd081623130306074f326df86aa10042d7d9e482e13e2e9ee3570fe30ab0", "path": "test.txt", "encrypted": true, "available": true, ... }

Returns:

A handle to the encrypted IPFS content

Throws:

java.io.IOException

java.security.GeneralSecurityException

addIpfsContent

@GET
 @Path(value="/addipfs")
 @Produces(value="application/json")
SFHandle addIpfsContent(@QueryParam(value="addr")
                                                                                           java.lang.String owner,
                                                                                           @QueryParam(value="path")
                                                                                           java.lang.String path,
                                                                                           @QueryParam(value="url")
                                                                                           java.net.URL srcURL)
                                                                                    throws java.io.IOException,
                                                                                           java.security.GeneralSecurityException

Add IPFS content from the given path or URL. The owner address must have been registered with the system so that the content can be properly encrypted before it is added to IPFS. Encrypted content must be given a unique path in the owner's namespace. The URL parameter is optional. If not given the path is interpreted as a relative path in the owner's namespace. It can point to a single file or a directory, in which case the whole document tree is encrypted and added to IPFS. URL Example: curl -f http://192.168.178.20:8081/nessus/addipfs?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB\&path=userfile.txt\&url=https://raw.githubusercontent.com/jboss-fuse/nessus/master/ipfs/jaxrs/src/test/resources/userfile.txt { "cid": "QmUVjhRvnvrXtu5KtBRdLp1zjG5jwMJEjBV6Efag6cw69T", "owner": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "txId": "65f63ad78d5798dd29f259f913ed8659c484c6fab57e0b9bc9bfa694d1eef5eb", "path": "userfile.txt", "encrypted": true, "available": true, ... } Path Example: curl -f http://192.168.178.20:8081/nessus/addipfs?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB\&path=contentA { "cid": "QmNpjzWvd7ZqkeqitGCXYvLHvyNQZ6SPJhU9uG9NFKX8ug", "owner": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "txId": "5c408ffcad460e8b3940f5cfc4f479aa0d703a86f105fefc285e9d57b849a19b", "path": "contentA", "encrypted": true, "available": true, ... "children": [{...}] }

Returns:

A handle to the encrypted IPFS content

Throws:

java.io.IOException

java.security.GeneralSecurityException

getIpfsContent

@GET
 @Path(value="/getipfs")
 @Produces(value="application/json")
SFHandle getIpfsContent(@QueryParam(value="addr")
                                                                                           java.lang.String owner,
                                                                                           @QueryParam(value="cid")
                                                                                           java.lang.String cid,
                                                                                           @QueryParam(value="path")
                                                                                           java.lang.String path,
                                                                                           @QueryParam(value="timeout")
                                                                                           java.lang.Long timeout)
                                                                                    throws java.io.IOException,
                                                                                           java.security.GeneralSecurityException

Get IPFS content by id. The owner address must have been registered with the system so that the content can be properly decrypted before it is stored. Decrypted content must be given a unique path in the owner's namespace. Example: curl -f http://192.168.178.20:8081/nessus/getipfs?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB\&path=foo.txt\&cid=Qme7mLoshqb8E8szmebWqiY8o1UbMAYcWL1b3YdTyPv6Ds { "owner": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "path": "foo.txt", "encrypted": false, "available": true, ... }

Parameters:

timeout - The optional timeout in miliseconds that IPFS is given to find the content on the network.

Returns:

A handle to the decrypted local content

Throws:

java.io.IOException

java.security.GeneralSecurityException

sendIpfsContent

@GET
 @Path(value="/sendipfs")
 @Produces(value="application/json")
SFHandle sendIpfsContent(@QueryParam(value="addr")
                                                                                             java.lang.String owner,
                                                                                             @QueryParam(value="cid")
                                                                                             java.lang.String cid,
                                                                                             @QueryParam(value="target")
                                                                                             java.lang.String target,
                                                                                             @QueryParam(value="timeout")
                                                                                             java.lang.Long timeout)
                                                                                      throws java.io.IOException,
                                                                                             java.security.GeneralSecurityException

Send IPFS content to a target address. The owner and the target address must have been registered with the system so that the content can be properly decrypted before it is stored. The system first gets the encrypted content from IPFS, then decrypts it with the owner's private key, then encrypts it again with the receipient's public key and finally registeres a DATA transaction on the blockchain that records the content transfer. Example: ipfs cat Qme7mLoshqb8E8szmebWqiY8o1UbMAYcWL1b3YdTyPv6Ds curl -f http://192.168.178.20:8081/nessus/findkey?addr=mm2PoHeFncAStYeZJSSTa4bmUVXRa3L6PL curl -f http://192.168.178.20:8081/nessus/sendipfs?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB&target=mm2PoHeFncAStYeZJSSTa4bmUVXRa3L6PL&cid=Qme7mLoshqb8E8szmebWqiY8o1UbMAYcWL1b3YdTyPv6Ds { "cid": "QmZWCV3c75ShzyuGaJ38yFQWv3zPDvzAAb4g8oygh7AGDH", "owner": "mm2PoHeFncAStYeZJSSTa4bmUVXRa3L6PL", "txId": "08675978946c793460c530b20de93b4ce94640e614bded56976c5ffe954b5aee", "path": "test.txt", "encrypted": true, "available": true, ... }

Parameters:

timeout - The optional timeout in miliseconds that IPFS is given to find the content on the network.

Returns:

A handle to the encrypted IPFS content

Throws:

java.io.IOException

java.security.GeneralSecurityException

findIpfsContent

@GET
 @Path(value="/findipfs")
 @Produces(value="application/json")
java.util.List<SFHandle> findIpfsContent(@QueryParam(value="addr")
                                                                                                             java.lang.String owner,
                                                                                                             @QueryParam(value="timeout")
                                                                                                             java.lang.Long timeout)
                                                                                                      throws java.io.IOException

Find IPFS content for a given owner address. The owner must have been registered with the system. The system finds IPFS content registrations based on unspent transaction outputs. Example: curl -f http://192.168.178.20:8081/nessus/findipfs?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB { "cid": "QmNpjzWvd7ZqkeqitGCXYvLHvyNQZ6SPJhU9uG9NFKX8ug", "owner": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "txId": "5c408ffcad460e8b3940f5cfc4f479aa0d703a86f105fefc285e9d57b849a19b", "path": "contentA", "encrypted": true, "available": true, ... }

Parameters:

timeout - The optional timeout in miliseconds that IPFS is given to find the content on the network.

Returns:

A handle to the encrypted IPFS content

Throws:

java.io.IOException

unregisterIpfsContent

@GET
 @Path(value="/rmipfs")
 @Produces(value="application/json")
java.util.List<java.lang.String> unregisterIpfsContent(@QueryParam(value="addr")
                                                                                                                         java.lang.String owner,
                                                                                                                         @QueryParam(value="cid")
                                                                                                                         java.util.List<java.lang.String> cids)
                                                                                                                  throws java.io.IOException

Unregister IPFS content. Similarly to "unregister address", this spends the UTXO for the IPFS content registration. Example: curl -f http://192.168.178.20:8081/nessus/rmipfs?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB\&cid=QmUVjhRvnvrXtu5KtBRdLp1zjG5jwMJEjBV6Efag6cw69T ["QmUVjhRvnvrXtu5KtBRdLp1zjG5jwMJEjBV6Efag6cw69T"]

Returns:

An array of unregistered content ids

Throws:

java.io.IOException

findLocalContent

@GET
 @Path(value="/findlocal")
 @Produces(value="application/json")
java.util.List<SFHandle> findLocalContent(@QueryParam(value="addr")
                                                                                                               java.lang.String owner,
                                                                                                               @QueryParam(value="path")
                                                                                                               java.lang.String path)
                                                                                                        throws java.io.IOException

Find local content for a given owner. Example: curl -f http://192.168.178.20:8081/nessus/findlocal?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB { "owner": "mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB", "path": "foo.txt", "encrypted": false, "available": true, ... }

Parameters:

path - An optional conent path

Returns:

A list of handles to decrypted local content

Throws:

java.io.IOException

getLocalContent

@GET
 @Path(value="/getlocal")
 @Produces(value="application/octet-stream")
java.io.InputStream getLocalContent(@QueryParam(value="addr")
                                                                                                                java.lang.String owner,
                                                                                                                @QueryParam(value="path")
                                                                                                                java.lang.String path)
                                                                                                         throws java.io.IOException

Gets local content for a given owner. Example: curl -f http://192.168.178.20:8081/nessus/getlocal?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB\&path=foo.txt Hello World

Throws:

java.io.IOException

removeLocalContent

@GET
 @Path(value="/rmlocal")
 @Produces(value="text/plain")
boolean removeLocalContent(@QueryParam(value="addr")
                                                                                        java.lang.String owner,
                                                                                        @QueryParam(value="path")
                                                                                        java.lang.String path)
                                                                                 throws java.io.IOException

Remove local content for a given owner. Example: curl -f http://192.168.178.20:8081/nessus/rmlocal?addr=mt5CNtbvx9qSxCRze5AqTDdsr4CZCn9MQB\&path=foo.txt

Throws:

java.io.IOException