afJ0ddlZddlmZmZmZmZmZmZmZddl m Z ddl m Z m Z mZmZmZmZmZmZmZmZmZddlmZmZdZe GddejZe Gd d ejZe Gd d ejZeee Gd dejZ e GddejZ!GddejZ"e Gdde"Z#GddejZ$e GddejZ%e Gdde%Z&e Gdde%Z'e GddejZ(e Gdd ejZ)dS)!N)UnionDictAnyOptionalListTupleCallable)public) ChallengeSessionDetails CloseDetails CallResultRegisterOptionsSubscribeOptions Registration Subscription PublicationComponentConfigTransportDetails)MessageWelcome) IObjectSerializer ISerializerIMessage ITransportITransportHandlerISessionIAuthenticatorIKeyICryptosignKey IEthereumKeyISecurityModule IPayloadCodecceZdZdZeeejdefdZ eeejde fdZ eejde de fdZeejde dee fdZd S) rz Raw Python object serialization and deserialization. Object serializers are used by classes implementing WAMP serializers, that is instances of :class:`autobahn.wamp.interfaces.ISerializer`. returncdS)z5 Object serializer name (read-only). Nselfs J/var/www/html/env/lib/python3.11/site-packages/autobahn/wamp/interfaces.pyNAMEzIObjectSerializer.NAME>cdS)z Flag (read-only) to indicate if serializer requires a binary clean transport or if UTF8 transparency is sufficient. Nr'r(s r*BINARYzIObjectSerializer.BINARYFr,r-objcdS)z Serialize an object to a byte string. :param obj: Object (any serializable type) to serialize. :returns: Serialized bytes. Nr')r)r0s r* serializezIObjectSerializer.serializeOr,r-payloadcdS)z Deserialize objects from a byte string. :param payload: Objects to deserialize. :returns: List of deserialized (raw) objects. Nr')r)r3s r* unserializezIObjectSerializer.unserializeZr,r-N)__name__ __module__ __qualname____doc__r propertyabcabstractmethodstrr+boolr/rbytesr2rr5r'r-r*rr6s    c   X V       X V   S U    V   5 T#Y    V   r-rc eZdZdZeeejdee dffdZ eeejde fdZ eeejde fdZ eeejde fdZeejdddeeeffd Zeejdd ed eededfd Zd S)rz9 WAMP message serialization and deserialization. r%rcdS)zM Mapping of WAMP message type codes to WAMP message classes. Nr'r(s r*MESSAGE_TYPE_MAPzISerializer.MESSAGE_TYPE_MAPlr,r-cdS)z{ The WAMP serialization format ID as used for WebSocket, e.g. ``"json"`` (or ``"json.batched"``) for JSON. Nr'r(s r* SERIALIZER_IDzISerializer.SERIALIZER_IDtr,r-cdS)z^ The WAMP serialization format ID as used for RawSocket, e.g. ``1`` for JSON. Nr'r(s r*RAWSOCKET_SERIALIZER_IDz#ISerializer.RAWSOCKET_SERIALIZER_ID|r,r-cdS)z` The WAMP serialization format MIME type, e.g. ``"application/json"`` for JSON. Nr'r(s r* MIME_TYPEzISerializer.MIME_TYPEr,r-messagecdS)z Serializes a WAMP message to bytes for sending over a WAMP transport. :param message: The WAMP message to be serialized. :returns: A pair ``(payload, is_binary)``. Nr'r)rIs r*r2zISerializer.serializer,r-Nr3 is_binarycdS)a8 Deserialize bytes from a transport and parse into WAMP messages. :param payload: Byte string from wire. :param is_binary: Type of payload. True if payload is a binary string, else the payload is UTF-8 encoded Unicode text. :returns: List of WAMP messages. Nr')r)r3rLs r*r5zISerializer.unserializer,r-N)r6r7r8r9r r:r;r<rintrBr=rDrFrHrr?r>r2rrr5r'r-r*rrfs   $sJ"7   X V    s   X V       X V    3   X V    eTk0B    V     5  Xd^  tT^O_     V    r-rceZdZdZeeejdefdZ ee ejd dZ eejde de fdZeejdZdS) rz A WAMP message, e.g. one of the messages defined in the WAMP specification `here `_. r%cdS)z) WAMP message type code. Nr'r(s r* MESSAGE_TYPEzIMessage.MESSAGE_TYPEr,r-cdS)z Factory method that parses a unserialized raw message (as returned byte :func:`autobahn.interfaces.ISerializer.unserialize`) into an instance of this class. :returns: The parsed WAMP message. Nr')wmsgs r*parsezIMessage.parser,r- serializercdS)aP Serialize this object into a wire level bytes representation and cache the resulting bytes. If the cache already contains an entry for the given serializer, return the cached representation directly. :param serializer: The wire level serializer to use. :returns: The serialized bytes. Nr')r)rVs r*r2zIMessage.serializer,r-cdS)zB Resets the serialization cache for this message. Nr'r(s r*uncachezIMessage.uncacher,r-N)r%r)r6r7r8r9r r:r;r<rOrR staticmethodrUrr?r2rYr'r-r*rrs    c   X V     \ V    K  E     V      V   r-rc0eZdZdZeejdefdZeejde fdZ ee ejde e fdZeejdZeejdZd S) rzi A WAMP transport is a bidirectional, full-duplex, reliable, ordered, message-based channel. rIcdS)a Send a WAMP message over the transport to the peer. If the transport is not open, this raises :class:`autobahn.wamp.exception.TransportLost`. Returns a deferred/future when the message has been processed and more messages may be sent. When send() is called while a previous deferred/future has not yet fired, the send will fail immediately. :param message: The WAMP message to send over the transport. Nr'rKs r*sendzITransport.sendr,r-r%cdS)zv Check if the transport is open for messaging. :returns: ``True``, if the transport is open. Nr'r(s r*isOpenzITransport.isOpenr,r-cdS)zR Return details about the transport (when the transport is open). Nr'r(s r*transport_detailszITransport.transport_detailsr,r-cdS)z Close the transport regularly. The transport will perform any closing handshake if applicable. This should be used for any application initiated closing. Nr'r(s r*closezITransport.closer,r-cdS)a Abort the transport abruptly. The transport will be destroyed as fast as possible, and without playing nice to the peer. This should only be used in case of fatal errors, protocol violations or possible detected attacks. Nr'r(s r*abortzITransport.abort r,r-N)r6r7r8r9r r;r<rr]r>r_r:rrrarcrer'r-r*rrs    H     V        V    8,<#=   X V     V     V   r-rceZdZeejdefdZeejdefdZ eejde fdZ dS)r transportcdS)a  Callback fired when transport is open. May run asynchronously. The transport is considered running and is_open() would return true, as soon as this callback has completed successfully. :param transport: The WAMP transport. Nr')r)rgs r*onOpenzITransportHandler.onOpenr,r-rIcdS)a_ Callback fired when a WAMP message was received. May run asynchronously. The callback should return or fire the returned deferred/future when it's done processing the message. In particular, an implementation of this callback must not access the message afterwards. :param message: The WAMP message received. Nr'rKs r* onMessagezITransportHandler.onMessage"r,r-wasCleancdS)z Callback fired when the transport has been closed. :param wasClean: Indicates if the transport has been closed regularly. Nr')r)rls r*onClosezITransportHandler.onClose-r,r-N) r6r7r8r r;r<rrirrkr>rnr'r-r*rrs      V       V       V   r-rc&eZdZejjZdS)_ABCN)r6r7r8r;ABCregister abc_registerr'r-r*rprp8s7#LLLr-rpceZdZdZeeejdefdZ eeejde e fdZ eeejde e fdZeejdZeejdZeej d2d ed e eed e ed e ed e eeefde ede ede efdZeejdedefdZeejdede efdZeejde fdZeejd3de ede efdZeejdefdZeejdZ eejdZ!eejdefdZ"eejdefdZ#eejd e d!fd"Z$eejde d!fd#Z%eejd4d$e&d%e efd&Z'eejd'ede(ee)ffd(Z*eej d5d)e(e+efd'e ed*e e,d+e ed,e ede(e-ee-ff d-Z.eejd.ede e/fd/Z0eej d6d0e(e+efd.e ed*e e1d,e ede(e2ee2ff d1Z3dS)7rz& Interface for WAMP sessions. r%cdS)z, Configuration for session. Nr'r(s r*configzISession.configBr,r-cdS)z When the transport this session is attached to is currently open, this property can be read from. The property should be considered read-only. When the transport is gone, this property is set to None. Nr'r(s r*rgzISession.transportJr,r-cdS)z Return details about the session, the same as initially provided to the :meth:`ISession.onJoin` callback on an implementation. Nr'r(s r*session_detailszISession.session_detailsTr,r-cdS)a This is called when we try to fire a callback, but get an exception from user code -- for example, a registered publish callback or a registered method. By default, this prints the current stack-trace and then error-message to stdout. ApplicationSession-derived objects may override this to provide logging if they prefer. The Twisted implemention does this. (See :class:`autobahn.twisted.wamp.ApplicationSession`) :param fail: The failure that occurred. :type fail: instance implementing txaio.IFailedFuture :param msg: an informative message from the library. It is suggested you log this immediately after the exception. :type msg: str Nr')r)failmsgs r* onUserErrorzISession.onUserError]r,r-cdS)zd Callback fired when the transport this session will run over has been established. Nr'r(s r* onConnectzISession.onConnectrr,r-Nrealm authmethodsauthidauthrole authextra resumableresume_session resume_tokenc dS)zp Attach the session to the given realm. A session is open as soon as it is attached to a realm. Nr') r)rrrrrrrrs r*joinz ISession.joinyr,r- challengecdS)z Callback fired when the peer demands authentication. May return a Deferred/Future. :param challenge: The authentication challenge. Nr')r)rs r* onChallengezISession.onChallenger,r-welcomecdS)a Callback fired after the peer has successfully authenticated. If this returns anything other than None/False, the session is aborted and the return value is used as an error message. May return a Deferred/Future. .. note:: Before we let user code see the session -- that is, before we fire "join" we give authentication instances a chance to abort the session. Usually this would be for "mutual authentication" scenarios. For example, WAMP-SCRAM uses this to confirm the server-signature. :param welcome: The WELCOME message received from the server :return: None, or an error message (using a fixed error URI ``wamp.error.cannot_authenticate``). Nr')r)rs r* onWelcomezISession.onWelcomer,r-detailscdS)z Callback fired when WAMP session has been established. May return a Deferred/Future. :param details: Session information. Nr'r)rs r*onJoinzISession.onJoinr,r-reasonrIcdS)a Actively close this WAMP session. :param reason: An optional URI for the closing reason. If you want to permanently log out, this should be ``wamp.close.logout``. :param message: An optional (human-readable) closing message, intended for logging purposes. :return: may return a Future/Deferred that fires when we've disconnected Nr')r)rrIs r*leavezISession.leaver,r-cdS)zx Callback fired when WAMP session has is closed :param details: Close information for session. Nr'rs r*onLeavezISession.onLeaver,r-cdS)z1 Close the underlying transport. Nr'r(s r* disconnectzISession.disconnectr,r-cdS)zK Callback fired when underlying transport has been closed. Nr'r(s r* onDisconnectzISession.onDisconnectr,r-cdS)zA Check if the underlying transport is connected. Nr'r(s r* is_connectedzISession.is_connectedr,r-cdS)zD Check if the session has currently joined a realm. Nr'r(s r* is_attachedzISession.is_attachedr,r- payload_codecr#cdS)aD Set a payload codec on the session. To remove a previously set payload codec, set the codec to ``None``. Payload codecs are used with WAMP payload transparency mode. :param payload_codec: The payload codec that should process application payload of the given encoding. Nr')r)rs r*set_payload_codeczISession.set_payload_codecr,r-cdS)z Get the current payload codec (if any) for the session. Payload codecs are used with WAMP payload transparency mode. :returns: The current payload codec or ``None`` if no codec is active. Nr'r(s r*get_payload_codeczISession.get_payload_codecr,r- exceptionerrorcdS)aR Defines an exception for a WAMP error in the context of this WAMP session. :param exception: The exception class to define an error mapping for. :param error: The URI (or URI pattern) the exception class should be mapped for. Iff the ``exception`` class is decorated, this must be ``None``. Nr')r)rrs r*definezISession.definer,r- procedurecdS)a Call a remote procedure. This will return a Deferred/Future, that when resolved, provides the actual result returned by the called remote procedure. - If the result is a single positional return value, it'll be returned "as-is". - If the result contains multiple positional return values or keyword return values, the result is wrapped in an instance of :class:`autobahn.wamp.types.CallResult`. - If the call fails, the returned Deferred/Future will be rejected with an instance of :class:`autobahn.wamp.exception.ApplicationError`. If ``kwargs`` contains an ``options`` keyword argument that is an instance of :class:`autobahn.wamp.types.CallOptions`, this will provide specific options for the call to perform. When the *Caller* and *Dealer* implementations support canceling of calls, the call may be canceled by canceling the returned Deferred/Future. :param procedure: The URI of the remote procedure to be called, e.g. ``"com.myapp.hello"``. :param args: Any positional arguments for the call. :param kwargs: Any keyword arguments for the call. :returns: A Deferred/Future for the call result. Nr')r)rargskwargss r*callz ISession.call r,r-endpointoptionsprefix check_typescdS)a Register a procedure for remote calling. When ``endpoint`` is a callable (function, method or object that implements ``__call__``), then ``procedure`` must be provided and an instance of :tx:`twisted.internet.defer.Deferred` (when running on **Twisted**) or an instance of :py:class:`asyncio.Future` (when running on **asyncio**) is returned. - If the registration *succeeds* the returned Deferred/Future will *resolve* to an object that implements :class:`autobahn.wamp.interfaces.IRegistration`. - If the registration *fails* the returned Deferred/Future will *reject* with an instance of :class:`autobahn.wamp.exception.ApplicationError`. When ``endpoint`` is an object, then each of the object's methods that is decorated with :func:`autobahn.wamp.register` is automatically registered and a (single) DeferredList or Future is returned that gathers all individual underlying Deferreds/Futures. :param endpoint: The endpoint called under the procedure. :param procedure: When ``endpoint`` is a callable, the URI (or URI pattern) of the procedure to register for. When ``endpoint`` is an object, the argument is ignored (and should be ``None``). :param options: Options for registering. :param prefix: if not None, this specifies a prefix to prepend to all URIs registered for this class. So if there was an @wamp.register('method_foo') on a method and prefix='com.something.' then a method 'com.something.method_foo' would ultimately be registered. :param check_types: Enable automatic type checking against (Python 3.5+) type hints specified on the ``endpoint`` callable. Types are checked at run-time on each invocation of the ``endpoint`` callable. When a type mismatch occurs, the error is forwarded to the callee code in ``onUserError`` override method of :class:`autobahn.wamp.protocol.ApplicationSession`. An error of type :class:`autobahn.wamp.exception.TypeCheckError` is also raised and returned to the caller (via the router). :returns: A registration or a list of registrations (or errors) Nr')r)rrrrrs r*rrzISession.register-r,r-topiccdS)a Publish an event to a topic. If ``kwargs`` contains an ``options`` keyword argument that is an instance of :class:`autobahn.wamp.types.PublishOptions`, this will provide specific options for the publish to perform. .. note:: By default, publications are non-acknowledged and the publication can fail silently, e.g. because the session is not authorized to publish to the topic. When publication acknowledgement is requested via ``options.acknowledge == True``, this function returns a Deferred/Future: - If the publication succeeds the Deferred/Future will resolve to an object that implements :class:`autobahn.wamp.interfaces.IPublication`. - If the publication fails the Deferred/Future will reject with an instance of :class:`autobahn.wamp.exception.ApplicationError`. :param topic: The URI of the topic to publish to, e.g. ``"com.myapp.mytopic1"``. :param args: Arbitrary application payload for the event (positional arguments). :param kwargs: Arbitrary application payload for the event (keyword arguments). :returns: Acknowledgement for acknowledge publications - otherwise nothing. Nr')r)rrrs r*publishzISession.publish]r,r-handlercdS)a Subscribe to a topic for receiving events. When ``handler`` is a callable (function, method or object that implements ``__call__``), then `topic` must be provided and an instance of :tx:`twisted.internet.defer.Deferred` (when running on **Twisted**) or an instance of :class:`asyncio.Future` (when running on **asyncio**) is returned. - If the subscription succeeds the Deferred/Future will resolve to an object that implements :class:`autobahn.wamp.interfaces.ISubscription`. - If the subscription fails the Deferred/Future will reject with an instance of :class:`autobahn.wamp.exception.ApplicationError`. When ``handler`` is an object, then each of the object's methods that is decorated with :func:`autobahn.wamp.subscribe` is automatically subscribed as event handlers, and a list of Deferreds/Futures is returned that each resolves or rejects as above. :param handler: The event handler to receive events. :param topic: When ``handler`` is a callable, the URI (or URI pattern) of the topic to subscribe to. When ``handler`` is an object, this value is ignored (and should be ``None``). :param options: Options for subscribing. :param check_types: Enable automatic type checking against (Python 3.5+) type hints specified on the ``endpoint`` callable. Types are checked at run-time on each invocation of the ``endpoint`` callable. When a type mismatch occurs, the error is forwarded to the subscriber code in ``onUserError`` override method of :class:`autobahn.wamp.protocol.ApplicationSession`. :returns: A single Deferred/Future or a list of such objects Nr')r)rrrrs r* subscribezISession.subscribe~r,r-)NNNNNNNNNrN)NNNN)NNN)4r6r7r8r9r r:r;r<rrvrrrgr ryr}rr=rrrr>rOrr rrrrrr rrrrrrr Exceptionrrrrr rrrrrrrrrr'r-r*rr<s<      X V    8J/   X V    .!9   X V     V &    V  15%)'+37)--1+/     "49-  c]   }  !c3h0  !  &c]  $C=     V    Y 3    V    Xc]    V (  n    V     HSM  8C=     V    |    V     V     V   d    V   T    V    x/H     V    8O#<    V     (3-    V   c uS*_7M    V > RVTX/3, , x}!5, (3-, "?3, DLSM, &tn, 8=lDQ]L^>^8_, , ,  V, \  S h{6K    V > NR\`$ $ x}!5$ hsm$ #$45$ KSTX>$ ,\ 22 3$ $ $  V$ $ $ r-rceZdZdZejdedefdZejde e e e fde e fdZ dS) rz* Experimental authentication API. sessionrcdS)z Formulate a challenge response for the given session and Challenge instance. This is sent to the server in the AUTHENTICATE message. Nr')r)rrs r* on_challengezIAuthenticator.on_challenger,r-rr%cdS)ae This hook is called when the onWelcome/on_welcome hook is invoked in the protocol, with the 'authextra' dict extracted from the Welcome message. Usually this is used to verify the final message from the server (e.g. for mutual authentication). :return: None if the session is successful or an error-message Nr')r)rs r* on_welcomezIAuthenticator.on_welcomer,r-N)r6r7r8r9r;r<rr rrrr=rrr'r-r*rrs  H       HT#s(^$< #      r-rceZdZdZeejdedfdZeejdee fdZ eejde fdZ ejdde dee effd Zejde fd Zejd edefd Zejd ed edefdZdS)ral Interface to an asymmetric verification key, e.g. a WAMP-Cryptosign client or server authentication public key (with Ed25519), or a WAMP-XBR data transaction signature public key or address (with Ethereum). The key implementation can use various methods, such as a key read from a file, database table or a key residing in a hardware device. r%r"cdS)a When this key is hosted by a security module, return a reference. If the key is freestanding (exists of its own outside any security module or key store), return ``None``. :return: The security module of the key if the key is hosted. Nr'r(s r*security_modulezIKey.security_moduler,r-cdS)ar When this key is hosted by a security module, return an identifier to refer to this key within the security module. If the key is freestanding (exists of its own outside any security module or key store), return ``None``. :return: The identifier of this key within the security module if this key is hosted. Nr'r(s r*key_noz IKey.key_nor,r-cdS)a Type of key and signature scheme, currently one of: * ``ed25519``: Ed25519, that is **EdDSA** signing algo with **Curve25519** elliptic curve and **SHA-512** hash, used with WAMP-cryptosign session authentication * ``eth``: Ethereum, that is **ECDSA** signing algo, **secp256k1** elliptic curve and **Keccak-256** hash, used with WAMP-XBR data and transaction signatures :return: Key type, one of ``ed25519`` or ``eth``. Nr'r(s r*key_typez IKey.key_typer,r-FbinarycdS)z Returns the public key part of a signing key or the (public) verification key. :param binary: If the return type should be binary instead of hex :return: The public key in hex or byte encoding. Nr'r)rs r* public_keyzIKey.public_keyr,r-cdS)z Check if the key can be used to sign and create new signatures, or only to verify signatures. :returns: ``True``, if the key can be used for signing. Nr'r(s r*can_signz IKey.can_signr,r-datacdS)z Sign the given data, only available if ``can_sign == True``. This method (always) runs asynchronously. :param data: The data to be signed. :return: The signature, that is a future object that resolves to bytes. Nr'r)rs r*signz IKey.signr,r- signaturecdS)a@ Recover the signer from the data signed, and the signature given. This method (always) runs asynchronously. :param data: The data that was signed. :param signature: The signature over the data. :return: The signer public key that signed the data to create the signature given. Nr')r)rrs r*recoverz IKey.recover r,r-NF)r6r7r8r9r:r;r<rrrOrr=rr>rr?rrrrr'r-r*rrs *;!<   X       X    #    X      %U 2C      $       5      E e       r-rc eZdZdZej d dedeedee defdZ ej d dededeedee de f d Z dS) r z\ Interface to a WAMP-Cryptosign client authentication (or server verification) key. Nr channel_idchannel_id_typer%cdS)a Sign the data from the given WAMP challenge message, and the optional TLS channel ID using this key and return a valid signature that can be used in a WAMP-cryptosign authentication handshake. :param challenge: The WAMP challenge message as sent or received during the WAMP-cryptosign authentication handshake. This can be used by WAMP clients to compute the signature returned in the handshake, or by WAMP routers to verify the signature returned by clients, during WAMP-cryptosign client authentication. :param channel_id: Optional TLS channel ID. Using this binds the WAMP session authentication to the underlying TLS channel, and thus prevents authentication-forwarding attacks. :param channel_id_type: Optional TLS channel ID type, e.g. ``"tls-unique"``. :return: The signature, that is a future object that resolves to bytes. Nr')r)rrrs r*sign_challengezICryptosignKey.sign_challenger,r-rcdS)a Verify the data from the given WAMP challenge message, and the optional TLS channel ID to be signed by this key. :param challenge: The WAMP challenge message as sent or received during the WAMP-cryptosign authentication handshake. This can be used by WAMP clients to compute the signature returned within the handshake, or by WAMP routers to verify the signature returned by clients, during WAMP-cryptosign client authentication. :param signature: The signature to verify. :param channel_id: Optional TLS channel ID. Using this binds the WAMP session authentication to the underlying TLS channel, and thus prevents authentication-forwarding attacks. :param channel_id_type: Optional TLS channel ID type, e.g. ``"tls-unique"``. :return: Returns ``True`` if the signature over the data matches this key. Nr')r)rrrrs r*verify_challengezICryptosignKey.verify_challenge1r,r-r) r6r7r8r9r;r<r rr?r=rr>rr'r-r*r r s QU8<   x (0  AF    & ei:>  )  S[\aSb *23- CG      r-r c eZdZdZejd dedeee ffdZ ejde ee fde fdZ ejde ee fde d eee fdefd Zd S) r!z Interface to an Ethereum signing (or transaction verification) key, used for WAMP-XBR transaction signing (or verification). Frr%cdS)a? Returns the Ethereum (public) address of the key (which is derived from the public key). :param binary: Return address as 160 bits (20 bytes) binary instead of the ``0x`` prefixed hex, check-summed address as a string. :return: The address in hex or byte encoding. Nr'rs r*addresszIEthereumKey.addressLr,r-rcdS)a, Sign the given typed data according to `EIP712 `_ and create an Ethereum signature. :param data: The data to be signed. This must follow EIP712. :return: The signature, that is a future object that resolves to bytes. Nr'rs r*sign_typed_datazIEthereumKey.sign_typed_dataWr,r-rsigner_addresscdS)a Verify the given typed data according to `EIP712 `_ to be signed by this key. :param data: The data to be signed. This must follow EIP712. :param signature: The signature to be verified. :param signer_address: Address against which the signature is verified. :return: Returns ``True`` if the signature over the data matches this key. Nr')r)rrrs r*verify_typed_datazIEthereumKey.verify_typed_databr,r-Nr)r6r7r8r9r;r<r>rr=r?rrrrrr'r-r*r!r!Es    d uS%Z/@      DcN u       d38n    X]^ach^hXi  nr        r-r!ceZdZdZejdefdZejdedefdZ ejdede e e ffdZ ejdede e e fddfd Zejdeddfd Zejd Zejd Zeejdefd ZeejdefdZeejdefdZejdZejdZejdedefdZejdefdZejdedefdZejdedefdZejdedefdZdS)r"a Interface for key security modules, which * include filesystem and HSM backed persistent key implementations, and * provides secure key signature generation and verification with * two key types and signature schemes The two key types and signature schemes support WAMP-cryptosign based authentication for WAMP sessions, and WAMP-XBR based signed transactions and data encryption. References: * `SE050 APDU Specification (AN12413) `_ * https://neuromancer.sk/std/secg/secp256r1 * https://neuromancer.sk/std/secg/secp256k1 * https://asecuritysite.com/curve25519/eddsa2 * https://asecuritysite.com/secp256k1/ecdsa * https://safecurves.cr.yp.to/ * https://www.ietf.org/rfc/rfc3279.txt * https://crypto.stackexchange.com/questions/70927/naming-convention-for-nist-elliptic-curves-in-openssl * https://www.johndcook.com/blog/2018/08/21/a-tale-of-two-elliptic-curves/ r%cdS)z Get number of key pairs currently stored within the security module. :return: Current number of keys stored in security module. Nr'r(s r*__len__zISecurityModule.__len__r,r-rcdSz2 :param key_no: :return: Nr'r)rs r* __contains__zISecurityModule.__contains__r,r-cdS)z Get a key from the security module given the key number. :param key_no: Number of key to get. :return: The key, either a :class:`ICryptosignKey` or :class:`IEthereumKey` instance. Nr'rs r* __getitem__zISecurityModule.__getitem__r,r-keyNcdS)zF :param key_no: :param key: :return: Nr')r)rrs r* __setitem__zISecurityModule.__setitem__r,r-cdSrr'rs r* __delitem__zISecurityModule.__delitem__r,r-cdS)zV Open this security module. This method (always) runs asynchronously. Nr'r(s r*openzISecurityModule.openr,r-cdS)zW Close this security module. This method (always) runs asynchronously. Nr'r(s r*rczISecurityModule.closer,r-cdS)z Check if the security module is currently opened. Security module operations can only be run when the module is opened. :return: Flag indicating whether the security module is currently opened. Nr'r(s r*is_openzISecurityModule.is_openr,r-cdS)z Flag indicating whether this security module can be locked, e.g. by a user passphrase or PIN. :return: Flag indicating whether the security module can be locked/unlocked at all. Nr'r(s r*can_lockzISecurityModule.can_lockr,r-cdS)z Check if this security module is currently locked. :return: Flag indicating whether the security module is currently locked. Nr'r(s r* is_lockedzISecurityModule.is_lockedr,r-cdS)zV Lock this security module. This method (always) runs asynchronously. Nr'r(s r*lockzISecurityModule.lockr,r-cdS)zX Unlock this security module. This method (always) runs asynchronously. Nr'r(s r*unlockzISecurityModule.unlockr,r-rcdS)z Create a new public-private asymmetric key pair, stored within the security module. :param key_type: Type of key to generate, e.g. ``"cryptosign"`` or ``"ethereum"``. :return: ID of new key. Nr')r)rs r* create_keyzISecurityModule.create_keyr,r-cdS)z} Delete an existing key pair stored within the security module. :param key_no: ID of key to delete. Nr'rs r* delete_keyzISecurityModule.delete_keyr,r-octetscdS)z Generate random bytes within the security module. :param octets: Number of bytes (octets) to generate. :return: Random bytes, generated within the security module, e.g. in a HW RNG. Nr')r)rs r* get_randomzISecurityModule.get_random r,r- counter_nocdS)z Return current value of the given persistent counter. :param counter_no: Counter to access. :return: Current value of counter, or ``0`` to indicate the counter does not exist (was never incremented). Nr'r)rs r* get_counterzISecurityModule.get_counterr,r-cdS)z Increment the given persistent counter and return the new value. :param counter_no: Counter to increment and access. :return: New value of counter, e.g. ``1`` once a counter was first incremented. Nr'r s r*increment_counterz!ISecurityModule.increment_counterr,r-)r6r7r8r9r;r<rOrr>rrr r!rrrrrcr:rrrrrr=rrr?rr r r'r-r*r"r"ps;.        3 4    *  # % 0L*M      # E.,2N,O TX      # $                X  $   X  4   X           3 3                   c c      C C      r-r"cteZdZdZeejddZeejdZdS)r#a{ WAMP payload codecs are used with WAMP payload transparency mode. In payload transparency mode, application payloads are transmitted "raw", as binary strings, without any processing at the WAMP router. Payload transparency can be used eg for these use cases: * end-to-end encryption of application payloads (WAMP-cryptobox) * using serializers with custom user types, where the serializer and the serializer implementation has native support for serializing custom types (such as CBOR) * transmitting MQTT payloads within WAMP, when the WAMP router is providing a MQTT-WAMP bridge NcdS)a Encodes application payload. :param is_originating: Flag indicating whether the encoding is to be done from an originator (a caller or publisher). :type is_originating: bool :param uri: The WAMP URI associated with the WAMP message for which the payload is to be encoded (eg topic or procedure). :type uri: str :param args: Positional application payload. :type args: list or None :param kwargs: Keyword-based application payload. :type kwargs: dict or None :returns: The encoded application payload or None to signal no encoding should be used. :rtype: instance of :class:`autobahn.wamp.types.EncodedPayload` Nr')r)is_originatingurirrs r*encodezIPayloadCodec.encode;r,r-cdS)a Decode application payload. :param is_originating: Flag indicating whether the encoding is to be done from an originator (a caller or publisher). :type is_originating: bool :param uri: The WAMP URI associated with the WAMP message for which the payload is to be encoded (eg topic or procedure). :type uri: str :param encoded_payload: The encoded application payload to be decoded. :type encoded_payload: instance of :class:`autobahn.wamp.types.EncodedPayload` :returns: A tuple with the decoded positional and keyword-based application payload: ``(uri, args, kwargs)`` :rtype: tuple Nr')r)rrencoded_payloads r*decodezIPayloadCodec.decodeTr,r-r) r6r7r8r9r r;r<rrr'r-r*r#r#)su      V .    V   r-r#)*r;typingrrrrrrr autobahn.utilr autobahn.wamp.typesr r r rrrrrrrrautobahn.wamp.messagerr__all__rqrrrrrrrrprrrr r!r"r#r'r-r*rs6 DDDDDDDDDDDDDDDDDD ! aaaaaaaaaaaaaaaaaaaaaaaaaa22222222  , , , , , , , , ^< < < < < #'< < < ~. . . . . sw. . . b '5 5 5 5 5 5 5 5 p        F$$$$$37$$$g g g g g tg g g T      SW   2S S S S S 37S S S l* * * * * T* * * Z' ' ' ' ' 4' ' ' Tu u u u u cgu u u p> > > > > CG> > > > > r-