org.zeromq

Class ZAuth

java.lang.Object

org.zeromq.ZAuth

All Implemented Interfaces:

Closeable, AutoCloseable

public class ZAuth
extends Object
implements Closeable

A ZAuth actor takes over authentication for all incoming connections in its context. You can whitelist or blacklist peers based on IP address, and define policies for securing PLAIN, CURVE, and GSSAPI connections.
Note that libzmq provides four levels of security: default NULL (which ZAuth does not see), and authenticated NULL, PLAIN, and CURVE, which ZAuth can see.
Based on zauth.c in czmq

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ZAuth.Auth
static class	ZAuth.SimpleCurveAuth
static class	ZAuth.SimpleNullAuth
static class	ZAuth.SimplePlainAuth
static class	ZAuth.ZapReply
static class	ZAuth.ZapRequest A small class for working with ZAP requests and replies.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURVE_ALLOW_ANY

Constructor Summary

Constructors

Constructor and Description
ZAuth(ZContext ctx) Install authentication for the specified context.
ZAuth(ZContext ctx, String actorName)
ZAuth(ZContext ctx, String actorName, Map<String,ZAuth.Auth> auths)
ZAuth(ZContext ctx, ZCertStore.Fingerprinter fingerprinter)

Method Summary

Methods

Modifier and Type	Method and Description
ZAuth	allow(String address) Allow (whitelist) a single IP address.
void	close() Destructor.
ZAuth	configureCurve(String location) Configure CURVE authentication
ZAuth	configurePlain(String domain, String filename) Configure PLAIN authentication for a given domain.
ZAuth	deny(String address) Deny (blacklist) a single IP address.
void	destroy() Destructor.
ZAuth.ZapReply	nextReply() Retrieves the next ZAP reply.
ZAuth.ZapReply	nextReply(boolean wait) Retrieves the next ZAP reply.
ZAuth.ZapReply	nextReply(int timeout) Retrieves the next ZAP reply.
ZAuth	replies(boolean enable)
protected ZAuth	send(String command, String... datas)
ZAuth	setVerbose(boolean verbose) Enable verbose tracing of commands and activity
ZAuth	verbose(boolean verbose)

Methods inherited from class java.lang.Object

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

Field Detail

CURVE_ALLOW_ANY

public static final String CURVE_ALLOW_ANY

See Also:

Constant Field Values

Constructor Detail

ZAuth

public ZAuth(ZContext ctx)

Install authentication for the specified context. Note that until you add policies, all incoming NULL connections are allowed (classic ZeroMQ behavior), and all PLAIN and CURVE connections are denied.

ZAuth

public ZAuth(ZContext ctx,
     ZCertStore.Fingerprinter fingerprinter)

ZAuth

public ZAuth(ZContext ctx,
     String actorName)

ZAuth

public ZAuth(ZContext ctx,
     String actorName,
     Map<String,ZAuth.Auth> auths)

Method Detail

setVerbose

public ZAuth setVerbose(boolean verbose)

Enable verbose tracing of commands and activity

verbose

public ZAuth verbose(boolean verbose)

allow

public ZAuth allow(String address)

Allow (whitelist) a single IP address. For NULL, all clients from this address will be accepted. For PLAIN and CURVE, they will be allowed to continue with authentication. You can call this method multiple times to whitelist multiple IP addresses. If you whitelist a single address, any non-whitelisted addresses are treated as blacklisted.

deny

public ZAuth deny(String address)

Deny (blacklist) a single IP address. For all security mechanisms, this rejects the connection without any further authentication. Use either a whitelist, or a blacklist, not not both. If you define both a whitelist and a blacklist, only the whitelist takes effect.

configurePlain

public ZAuth configurePlain(String domain,
                   String filename)

Configure PLAIN authentication for a given domain. PLAIN authentication uses a plain-text password file. To cover all domains, use "*". You can modify the password file at any time; it is reloaded automatically.

configureCurve

public ZAuth configureCurve(String location)

Configure CURVE authentication

Parameters:

location - Can be ZAuth.CURVE_ALLOW_ANY or a directory with public-keys that will be accepted

replies

public ZAuth replies(boolean enable)

nextReply

public ZAuth.ZapReply nextReply()

Retrieves the next ZAP reply.

Returns:

the next reply or null if the actor is closed.

nextReply

public ZAuth.ZapReply nextReply(boolean wait)

Retrieves the next ZAP reply.

Parameters:

wait - true to wait for the next reply, false to immediately return if there is no next reply.

Returns:

the next reply or null if the actor is closed or if there is no next reply yet.

nextReply

public ZAuth.ZapReply nextReply(int timeout)

Retrieves the next ZAP reply.

Parameters:

timeout - the timeout in milliseconds to wait for a reply before giving up and returning null.

Returns:

the next reply or null if the actor is closed or if there is no next reply after the elapsed timeout.

close

public void close()
           throws IOException

Destructor.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

destroy

public void destroy()

Destructor.

send

protected ZAuth send(String command,
         String... datas)