circuitmatter.case
==================

.. py:module:: circuitmatter.case


Attributes
----------

.. autoapisummary::

   circuitmatter.case.root_public_key


Classes
-------

.. autoapisummary::

   circuitmatter.case.CASEMessage
   circuitmatter.case.Sigma1
   circuitmatter.case.Sigma2TbsData
   circuitmatter.case.Sigma2TbeData
   circuitmatter.case.Sigma2
   circuitmatter.case.Sigma3TbsData
   circuitmatter.case.Sigma3TbeData
   circuitmatter.case.Sigma3
   circuitmatter.case.Sigma2Resume


Functions
---------

.. autoapisummary::

   circuitmatter.case.compute_destination_id


Module Contents
---------------

.. py:class:: CASEMessage

   Bases: :py:obj:`circuitmatter.tlv.Structure`


   .. py:attribute:: PROTOCOL_ID


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:class:: Sigma1

   Bases: :py:obj:`CASEMessage`


   .. py:attribute:: PROTOCOL_OPCODE


   .. py:attribute:: initiatorRandom


   .. py:attribute:: initiatorSessionId


   .. py:attribute:: destinationId


   .. py:attribute:: initiatorEphPubKey


   .. py:attribute:: initiatorSessionParams


   .. py:attribute:: resumptionID


   .. py:attribute:: initiatorResumeMIC


   .. py:attribute:: PROTOCOL_ID


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:class:: Sigma2TbsData

   Bases: :py:obj:`circuitmatter.tlv.Structure`


   .. py:attribute:: responderNOC


   .. py:attribute:: responderICAC


   .. py:attribute:: responderEphPubKey


   .. py:attribute:: initiatorEphPubKey


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:class:: Sigma2TbeData

   Bases: :py:obj:`circuitmatter.tlv.Structure`


   .. py:attribute:: responderNOC


   .. py:attribute:: responderICAC


   .. py:attribute:: signature


   .. py:attribute:: resumptionID


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:class:: Sigma2

   Bases: :py:obj:`CASEMessage`


   .. py:attribute:: PROTOCOL_OPCODE


   .. py:attribute:: responderRandom


   .. py:attribute:: responderSessionId


   .. py:attribute:: responderEphPubKey


   .. py:attribute:: encrypted2


   .. py:attribute:: responderSessionParams


   .. py:attribute:: PROTOCOL_ID


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:class:: Sigma3TbsData

   Bases: :py:obj:`circuitmatter.tlv.Structure`


   .. py:attribute:: initiatorNOC


   .. py:attribute:: initiatorICAC


   .. py:attribute:: initiatorEphPubKey


   .. py:attribute:: responderEphPubKey


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:class:: Sigma3TbeData

   Bases: :py:obj:`circuitmatter.tlv.Structure`


   .. py:attribute:: initiatorNOC


   .. py:attribute:: initiatorICAC


   .. py:attribute:: signature


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:class:: Sigma3

   Bases: :py:obj:`CASEMessage`


   .. py:attribute:: PROTOCOL_OPCODE


   .. py:attribute:: encrypted3


   .. py:attribute:: PROTOCOL_ID


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:class:: Sigma2Resume

   Bases: :py:obj:`CASEMessage`


   .. py:attribute:: PROTOCOL_OPCODE


   .. py:attribute:: resumptionID


   .. py:attribute:: sigma2ResumeMIC


   .. py:attribute:: responderSessionID


   .. py:attribute:: responderSessionParams


   .. py:attribute:: PROTOCOL_ID


   .. py:method:: __str__()


   .. py:method:: encode() -> memoryview


   .. py:method:: encode_into(buffer: bytearray, offset: int = 0) -> int


   .. py:method:: decode(buffer: memoryview, offset=0) -> Structure
      :classmethod:



   .. py:method:: decode_member(control_octet, buffer, offset=0, depth=0) -> tuple[dict, int]
      :classmethod:



   .. py:method:: construct_containers()


   .. py:method:: from_value(value)
      :classmethod:



   .. py:attribute:: values


   .. py:method:: max_length()
      :classmethod:



   .. py:method:: set_value(tag, value)


   .. py:method:: delete_value(tag)


.. py:function:: compute_destination_id(root_public_key, fabric_id, node_id, initiator_random, identity_protection_key)

.. py:data:: root_public_key