KOKINIO - MANAGER
Edit File: handshake.rst
.. LINENO 7 .. SPDX-License-Identifier: GPL-2.0 .. NOTE: This document was auto-generated. .. _netlink-handshake: ========================================== Family ``handshake`` netlink specification ========================================== .. contents:: :depth: 3 ------- Summary ------- Netlink protocol to request a transport layer security handshake. ---------- Operations ---------- .. LINENO 90 .. _handshake-operation-ready: ready ===== Notify handlers that a new handshake request is waiting :notify: accept .. LINENO 94 .. _handshake-operation-accept: accept ====== Handler retrieves next queued handshake request :attribute-set: :ref:`handshake-attribute-set-accept` :flags: [``admin-perm``] :do: .. LINENO 99 **request** :attributes: [``handler-class``] **reply** :attributes: [``sockfd``, ``message-type``, ``timeout``, ``auth-mode``, ``peer-identity``, ``certificate``, ``peername``] .. LINENO 112 .. _handshake-operation-done: done ==== Handler reports handshake completion :attribute-set: :ref:`handshake-attribute-set-done` :do: .. LINENO 116 **request** :attributes: [``status``, ``sockfd``, ``remote-auth``] ---------------- Multicast groups ---------------- - none - tlshd ----------- Definitions ----------- .. LINENO 15 .. _handshake-definition-handler-class: handler-class ============= :type: enum :value-start: 0 :entries: - ``none`` - ``tlshd`` - ``max`` .. LINENO 20 .. _handshake-definition-msg-type: msg-type ======== :type: enum :value-start: 0 :entries: - ``unspec`` - ``clienthello`` - ``serverhello`` .. LINENO 25 .. _handshake-definition-auth: auth ==== :type: enum :value-start: 0 :entries: - ``unspec`` - ``unauth`` - ``psk`` - ``x509`` -------------- Attribute sets -------------- .. _handshake-attribute-set-x509: x509 ==== .. LINENO 35 cert (``s32``) ~~~~~~~~~~~~~~ .. LINENO 38 privkey (``s32``) ~~~~~~~~~~~~~~~~~ .. _handshake-attribute-set-accept: accept ====== .. LINENO 44 sockfd (``s32``) ~~~~~~~~~~~~~~~~ .. LINENO 47 handler-class (``u32``) ~~~~~~~~~~~~~~~~~~~~~~~ :enum: :ref:`handshake-definition-handler-class` .. LINENO 51 message-type (``u32``) ~~~~~~~~~~~~~~~~~~~~~~ :enum: :ref:`handshake-definition-msg-type` .. LINENO 55 timeout (``u32``) ~~~~~~~~~~~~~~~~~ .. LINENO 58 auth-mode (``u32``) ~~~~~~~~~~~~~~~~~~~ :enum: :ref:`handshake-definition-auth` .. LINENO 62 peer-identity (``u32``) ~~~~~~~~~~~~~~~~~~~~~~~ :multi-attr: True .. LINENO 66 certificate (``nest``) ~~~~~~~~~~~~~~~~~~~~~~ :nested-attributes: :ref:`handshake-attribute-set-x509` :multi-attr: True .. LINENO 71 peername (``string``) ~~~~~~~~~~~~~~~~~~~~~ .. _handshake-attribute-set-done: done ==== .. LINENO 77 status (``u32``) ~~~~~~~~~~~~~~~~ .. LINENO 80 sockfd (``s32``) ~~~~~~~~~~~~~~~~ .. LINENO 83 remote-auth (``u32``) ~~~~~~~~~~~~~~~~~~~~~ :multi-attr: True