legacy-libs/grpc/deps/grpc/src/core/tsi/alts/zero_copy_frame_protector/alts_grpc_privacy_integrity_record_protocol.h

   1 /*
   2  *
   3  * Copyright 2018 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #ifndef GRPC_CORE_TSI_ALTS_ZERO_COPY_FRAME_PROTECTOR_ALTS_GRPC_PRIVACY_INTEGRITY_RECORD_PROTOCOL_H
  20 #define GRPC_CORE_TSI_ALTS_ZERO_COPY_FRAME_PROTECTOR_ALTS_GRPC_PRIVACY_INTEGRITY_RECORD_PROTOCOL_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include <stdbool.h>
  25
  26 #include "src/core/tsi/alts/crypt/gsec.h"
  27 #include "src/core/tsi/alts/zero_copy_frame_protector/alts_grpc_record_protocol.h"
  28
  29 /**
  30  * This method creates a privacy-integrity alts_grpc_record_protocol instance,
  31  * given a gsec_aead_crypter instance and a flag indicating if the created
  32  * instance will be used at the client or server side. The ownership of
  33  * gsec_aead_crypter instance is transferred to this new object.
  34  *
  35  * - crypter: a gsec_aead_crypter instance used to perform AEAD decryption.
  36  * - is_client: a flag indicating if the alts_grpc_record_protocol instance will
  37  *   be used at the client or server side.
  38  * - rp: an alts_grpc_record_protocol instance to be returned from
  39  *   the method.
  40  *
  41  * This method returns TSI_OK in case of success or a specific error code in
  42  * case of failure.
  43  */
  44 tsi_result alts_grpc_privacy_integrity_record_protocol_create(
  45     gsec_aead_crypter* crypter, size_t overflow_size, bool is_client,
  46     bool is_protect, alts_grpc_record_protocol** rp);
  47
  48 #endif /* GRPC_CORE_TSI_ALTS_ZERO_COPY_FRAME_PROTECTOR_ALTS_GRPC_PRIVACY_INTEGRITY_RECORD_PROTOCOL_H \
  49         */