nl-linux 0.3.0 → 0.4.1

data/sig/generated/nl/linux/handshake.rbs

@@ -0,0 +1,622 @@
+# Generated from generated/nl/linux/handshake.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # Netlink protocol to request a transport layer security handshake.
+    class Handshake < ::Nl::Genl::Family
+      NAME: ::String
+
+      VERSION: ::Integer
+
+      # @rbs (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+      # @rbs | [R] (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) { (instance) -> R } -> R
+      # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+      #   @param [#call] resolver
+      #   @param [Symbol, nil] executor
+      #   @param [Integer, nil] notification_capacity
+      #   @return [Handshake]
+      # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY, &block)
+      #   @param [#call] resolver
+      #   @param [Symbol, nil] executor
+      #   @param [Integer, nil] notification_capacity
+      #   @yieldparam [Handshake] family
+      #   @return [Object] the result of the block
+      def self.open: (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+
+      # @private
+      MCAST_GROUPS: Hash[::Symbol, ::Nl::McastGroup]
+
+      module Constants
+        MAX_ERRNO: ::Integer
+      end
+
+      module Enums
+        module HandlerClass
+          None: ::Integer
+
+          Tlshd: ::Integer
+
+          Max: ::Integer
+        end
+
+        module MsgType
+          Unspec: ::Integer
+
+          Clienthello: ::Integer
+
+          Serverhello: ::Integer
+        end
+
+        module Auth
+          Unspec: ::Integer
+
+          Unauth: ::Integer
+
+          Psk: ::Integer
+
+          X509: ::Integer
+        end
+      end
+
+      module Structs
+      end
+
+      module AttributeSets
+        class X509 < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Cert < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Privkey < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Cert
+          def cert: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Privkey
+          def privkey: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class Accept < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Sockfd < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Known enum values are defined in {Enums::HandlerClass}.
+          class HandlerClass < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Known enum values are defined in {Enums::MsgType}.
+          class MessageType < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Timeout < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Known enum values are defined in {Enums::Auth}.
+          class AuthMode < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class PeerIdentity < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            MULTI: bool
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Certificate < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            MULTI: bool
+
+            # @private
+            ORDER: ::Integer
+          end
+
+          class Peername < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Keyring < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Sockfd
+          def sockfd: () -> ::Integer
+
+          # Known enum values are defined in {Enums::HandlerClass}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see HandlerClass
+          def handler_class: () -> ::Integer
+
+          # Known enum values are defined in {Enums::MsgType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see MessageType
+          def message_type: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Timeout
+          def timeout: () -> ::Integer
+
+          # Known enum values are defined in {Enums::Auth}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AuthMode
+          def auth_mode: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see PeerIdentity
+          def peer_identity: () -> ::Array[::Integer]
+
+          # @rbs return: ::Array[AttributeSets::X509]
+          # @return [Array<AttributeSets::X509>]
+          # @see Certificate
+          def certificate: () -> ::Array[AttributeSets::X509]
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see Peername
+          def peername: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Keyring
+          def keyring: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+
+        class Done < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          class Status < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class Sockfd < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          class RemoteAuth < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            MULTI: bool
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Status
+          def status: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Sockfd
+          def sockfd: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see RemoteAuth
+          def remote_auth: () -> ::Array[::Integer]
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+      end
+
+      module Messages
+        # Handler retrieves next queued handshake request
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoAcceptRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # Known enum values are defined in {Enums::HandlerClass}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::HandlerClass
+          def handler_class: () -> ::Integer
+        end
+
+        # Handler retrieves next queued handshake request
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoAcceptReply < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::Sockfd
+          def sockfd: () -> ::Integer
+
+          # Known enum values are defined in {Enums::MsgType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::MessageType
+          def message_type: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::Timeout
+          def timeout: () -> ::Integer
+
+          # Known enum values are defined in {Enums::Auth}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::AuthMode
+          def auth_mode: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see AttributeSets::Accept::PeerIdentity
+          def peer_identity: () -> ::Array[::Integer]
+
+          # @rbs return: ::Array[AttributeSets::X509]
+          # @return [Array<AttributeSets::X509>]
+          # @see AttributeSets::Accept::Certificate
+          def certificate: () -> ::Array[AttributeSets::X509]
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Accept::Peername
+          def peername: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::Keyring
+          def keyring: () -> ::Integer
+        end
+
+        # Handler reports handshake completion
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        class DoDoneRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Done::Status
+          def status: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Done::Sockfd
+          def sockfd: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see AttributeSets::Done::RemoteAuth
+          def remote_auth: () -> ::Array[::Integer]
+        end
+      end
+
+      module Notifications
+        # Notify handlers that a new handshake request is waiting
+        class Ready < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::Sockfd
+          def sockfd: () -> ::Integer
+
+          # Known enum values are defined in {Enums::MsgType}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::MessageType
+          def message_type: () -> ::Integer
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::Timeout
+          def timeout: () -> ::Integer
+
+          # Known enum values are defined in {Enums::Auth}.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::AuthMode
+          def auth_mode: () -> ::Integer
+
+          # @rbs return: ::Array[::Integer]
+          # @return [Array<Integer>]
+          # @see AttributeSets::Accept::PeerIdentity
+          def peer_identity: () -> ::Array[::Integer]
+
+          # @rbs return: ::Array[AttributeSets::X509]
+          # @return [Array<AttributeSets::X509>]
+          # @see AttributeSets::Accept::Certificate
+          def certificate: () -> ::Array[AttributeSets::X509]
+
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Accept::Peername
+          def peername: () -> ::String
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Accept::Keyring
+          def keyring: () -> ::Integer
+        end
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      # Handler retrieves next queued handshake request
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?handler_class: ::Integer) -> Messages::DoAcceptReply
+      # @param [Hash] args
+      # @option args [Integer] handler_class Known enum values are defined in {Enums::HandlerClass}.
+      # @return [Messages::DoAcceptReply]
+      # @see Messages::DoAcceptRequest
+      def do_accept: (?handler_class: ::Integer) -> Messages::DoAcceptReply
+
+      # Handler reports handshake completion
+      #
+      # Requires CAP_NET_ADMIN in the initial user namespace.
+      # @rbs (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Array[::Integer]) -> void
+      # @param [Hash] args
+      # @option args [Integer] status
+      # @option args [Integer] sockfd
+      # @option args [Array<Integer>] remote_auth
+      # @return [void]
+      # @see Messages::DoDoneRequest
+      def do_done: (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Array[::Integer]) -> void
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # Handler retrieves next queued handshake request
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?handler_class: ::Integer) -> ::Nl::Async::Future[Messages::DoAcceptReply]
+        # @param [Hash] args
+        # @option args [Integer] handler_class Known enum values are defined in {Enums::HandlerClass}.
+        # @return [Nl::Async::Future<Messages::DoAcceptReply>]
+        # @see Messages::DoAcceptRequest
+        def do_accept: (?handler_class: ::Integer) -> ::Nl::Async::Future[Messages::DoAcceptReply]
+
+        # Handler reports handshake completion
+        #
+        # Requires CAP_NET_ADMIN in the initial user namespace.
+        # @rbs (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Array[::Integer]) -> ::Nl::Async::Future[void]
+        # @param [Hash] args
+        # @option args [Integer] status
+        # @option args [Integer] sockfd
+        # @option args [Array<Integer>] remote_auth
+        # @return [Nl::Async::Future<void>]
+        # @see Messages::DoDoneRequest
+        def do_done: (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Array[::Integer]) -> ::Nl::Async::Future[void]
+      end
+
+      # Returns the asynchronous operation facade for this family.
+      # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+      # @param [::Integer, nil] stream_capacity
+      # @return [AsyncOperations]
+      def async: (?stream_capacity: ::Integer?) -> AsyncOperations
+
+      # @rbs (*(:none | :tlshd) groups) -> self
+      # @param [Array<:none, :tlshd>] groups
+      # @return [self]
+      def subscribe: (*:none | :tlshd groups) -> self
+
+      # @rbs (*(:none | :tlshd) groups) -> self
+      # @param [Array<:none, :tlshd>] groups
+      # @return [self]
+      def unsubscribe: (*:none | :tlshd groups) -> self
+    end
+  end
+end