maskit commented on code in PR #12914: URL: https://github.com/apache/trafficserver/pull/12914#discussion_r2875639220
########## doc/developer-guide/api/types/TSClientHello.en.rst: ########## @@ -0,0 +1,82 @@ +.. Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed + with this work for additional information regarding copyright + ownership. The ASF licenses this file to you under the Apache + License, Version 2.0 (the "License"); you may not use this file + except in compliance with the License. You may obtain a copy of + the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. + +.. include:: ../../../common.defs + +.. default-domain:: cpp + +TSClientHello +************* + +Synopsis +======== + +.. code-block:: cpp + + #include <ts/apidefs.h> + +.. type:: TSClientHello + +.. type:: TSClientHello::TSExtensionTypeList + + A type alias for an iterable container of extension type IDs. + + +Description +=========== + +:type:`TSClientHello` is an opaque handle to a TLS ClientHello message sent by +a client during the TLS handshake. It provides access to the client's TLS +version, cipher suites, and extensions. + +The implementation abstracts differences between OpenSSL and BoringSSL to +provide a consistent interface. + +Accessor Methods +================ + +The following methods are available to access ClientHello data: + +.. function:: bool is_available() const + + Returns whether the object contains valid values. As long as + :func:`TSVConnClientHelloGet` is called for a TLS connection, the return + value should be `true`. + +.. function:: uint16_t get_version() const + + Returns the TLS version from the ClientHello message. + +.. function:: const uint8_t* get_cipher_suites() const + + Returns a pointer to the cipher suites buffer. The length is available via + :func:`get_cipher_suites_len()`. + +.. function:: size_t get_cipher_suites_len() const + + Returns the length of the cipher suites buffer in bytes. + +.. function:: TSClientHello::TSExtensionTypeList get_extension_types() const + + Returns an iterable container of extension type IDs present in the ClientHello. + This method abstracts the differences between BoringSSL (which uses an extensions + buffer) and OpenSSL (which uses an extension_ids array), providing a consistent + interface regardless of the SSL library in use. + +.. function:: void* _get_internal() const + + Returns the underlying SSL pointer. This is an internal accessor for advanced use + cases. Review Comment: Addressed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
