auth.thread¶
Classes¶
ThreadAuthenticator¶
-
class
zmq.auth.thread.ThreadAuthenticator(context=None, encoding='utf-8', log=None)¶ Run ZAP authentication in a background thread
-
__delattr__¶ x.__delattr__(‘name’) <==> del x.name
-
__format__()¶ default object formatter
-
__getattribute__¶ x.__getattribute__(‘name’) <==> x.name
-
__hash__¶
-
__reduce__()¶ helper for pickle
-
__reduce_ex__()¶ helper for pickle
-
__repr__¶
-
__setattr__¶ x.__setattr__(‘name’, value) <==> x.name = value
-
__sizeof__() → int¶ __sizeof__() -> int size of object in memory, in bytes
-
__str__¶
-
allow(*addresses)¶ Allow (whitelist) IP address(es).
Connections from addresses not in the whitelist will be rejected.
- For NULL, all clients from this address will be accepted.
- For PLAIN and CURVE, they will be allowed to continue with authentication.
whitelist is mutually exclusive with blacklist.
-
configure_curve(domain='*', location='')¶ Configure CURVE authentication for a given domain.
CURVE authentication uses a directory that holds all public client certificates, i.e. their public keys.
To cover all domains, use “*”.
You can add and remove certificates in that directory at any time.
To allow all client keys without checking, specify CURVE_ALLOW_ANY for the location.
-
configure_plain(domain='*', passwords=None)¶ 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.
-
deny(*addresses)¶ Deny (blacklist) IP address(es).
Addresses not in the blacklist will be allowed to continue with authentication.
Blacklist is mutually exclusive with whitelist.
-
is_alive()¶ Is the ZAP thread currently running?
-
start()¶ Start the authentication thread
-
stop()¶ Stop the authentication thread
-