iocore/net/quic/QUICHandshakeProtocol.h

/** @file
 *
 *  QUIC TLS
 *
 *  @section license License
 *
 *  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.
 */

#pragma once

#include "QUICKeyGenerator.h"
#include "QUICTypes.h"
#include "QUICTransportParameters.h"

class QUICHandshakeProtocol;
class QUICPacketProtectionKeyInfo;

struct QUICHandshakeMsgs {
  uint8_t *buf        = nullptr; //< pointer to the buffer
  size_t max_buf_len  = 0;       //< size of buffer
  size_t offsets[5]   = {0};     //< offset to the each encryption level - {initial, zero_rtt, handshake, one_rtt, total length}
  uint16_t error_code = 0;       //< CRYPTO_ERROR - TLS Alert Description + 0x100
};

class QUICHandshakeProtocol
{
public:
  QUICHandshakeProtocol(QUICPacketProtectionKeyInfo &pp_key_info) : _pp_key_info(pp_key_info) {}
  virtual ~QUICHandshakeProtocol(){};

  virtual int handshake(QUICHandshakeMsgs **out, const QUICHandshakeMsgs *in)             = 0;
  virtual void reset()                                                                    = 0;
  virtual bool is_handshake_finished() const                                              = 0;
  virtual bool is_ready_to_derive() const                                                 = 0;
  virtual int initialize_key_materials(QUICConnectionId cid)                              = 0;
  virtual const char *negotiated_cipher_suite() const                                     = 0;
  virtual void negotiated_application_name(const uint8_t **name, unsigned int *len) const = 0;

  virtual std::shared_ptr<const QUICTransportParameters> local_transport_parameters()             = 0;
  virtual std::shared_ptr<const QUICTransportParameters> remote_transport_parameters()            = 0;
  virtual void set_local_transport_parameters(std::shared_ptr<const QUICTransportParameters> tp)  = 0;
  virtual void set_remote_transport_parameters(std::shared_ptr<const QUICTransportParameters> tp) = 0;

  virtual QUICEncryptionLevel current_encryption_level() const = 0;
  virtual void abort_handshake()                               = 0;
  virtual bool has_crypto_error() const                        = 0;
  virtual uint64_t crypto_error() const                        = 0;

protected:
  QUICPacketProtectionKeyInfo &_pp_key_info;
};