org.zeromq

Class ZCert

java.lang.Object

org.zeromq.ZCert

public class ZCert
extends Object

The ZCert class provides a way to create and work with security certificates for the ZMQ CURVE mechanism. A certificate contains a public + secret key pair, plus metadata. It can be used as a temporary object in memory, or persisted to disk.

To exchange certificates, send the public file via some secure route. Certificates are not signed but are text files that can be verified by eye.

Certificates are stored in the ZeroMQ Property Language format.
They have two sections, "metadata" and "curve".
The first contains a list of 'name = value' pairs, one per line. Values may be enclosed in quotes.
The curve section has a 'public-key = key-value' and, for secret certificates, a 'secret-key = key-value' line.
The key-value is a Z85-encoded CURVE key.

Constructor Summary

Constructors

Constructor and Description
ZCert()
ZCert(byte[] publicKey, byte[] secretKey)
ZCert(String publicKey)
ZCert(String publicKey, String secretKey)
ZCert(ZMQ.Curve.KeyPair keypair)

Method Summary

Modifier and Type	Method and Description
void	apply(ZMQ.Socket socket)
String	getMeta(String key)
ZMetadata	getMetadata()
byte[]	getPublicKey()
String	getPublicKeyAsZ85()
byte[]	getSecretKey()
String	getSecretKeyAsZ85()
File	savePublic(String filename) Saves the public key to a file.
void	savePublic(Writer writer) Saves the public key to a writer.
File	saveSecret(String filename) Saves the public and secret keys to a file.
void	saveSecret(Writer writer) Saves the public and secret keys to a writer.
void	setMeta(String key, String value)
void	unsetMeta(String key)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZCert

public ZCert()

ZCert

public ZCert(String publicKey)

ZCert

public ZCert(ZMQ.Curve.KeyPair keypair)

ZCert

public ZCert(byte[] publicKey,
             byte[] secretKey)

ZCert

public ZCert(String publicKey,
             String secretKey)

Method Detail

getPublicKey

public byte[] getPublicKey()

getSecretKey

public byte[] getSecretKey()

getPublicKeyAsZ85

public String getPublicKeyAsZ85()

getSecretKeyAsZ85

public String getSecretKeyAsZ85()

apply

public void apply(ZMQ.Socket socket)

getMetadata

public ZMetadata getMetadata()

setMeta

public void setMeta(String key,
                    String value)

unsetMeta

public void unsetMeta(String key)

getMeta

public String getMeta(String key)

savePublic

public File savePublic(String filename)
                throws IOException

Saves the public key to a file.

This method will overwrite contents of existing file

Parameters:

filename - the path of the file to save the certificate into.

Returns:

the saved file or null if dumped to the standard output

Throws:

IOException - if unable to save the file.

savePublic

public void savePublic(Writer writer)
                throws IOException

Saves the public key to a writer.

Parameters:

writer - the writer to save the certificate into.

Throws:

IOException - if unable to dump the public configuration.

saveSecret

public File saveSecret(String filename)
                throws IOException

Saves the public and secret keys to a file.

This method will overwrite contents of existing file

Parameters:

filename - the path of the file to save the certificate into.

Returns:

the saved file or null if dumped to the standard output

Throws:

IOException - if unable to save the file.

saveSecret

public void saveSecret(Writer writer)
                throws IOException

Saves the public and secret keys to a writer.

Parameters:

writer - the writer to save the certificate into.

Throws:

IOException - if unable to dump the configuration.