src/core/tsi/local_transport_security.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_LOCAL_TRANSPORT_SECURITY_H
  20 #define GRPC_CORE_TSI_LOCAL_TRANSPORT_SECURITY_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include <grpc/grpc.h>
  25
  26 #include "src/core/tsi/transport_security.h"
  27 #include "src/core/tsi/transport_security_interface.h"
  28
  29 #define TSI_LOCAL_NUM_OF_PEER_PROPERTIES 1
  30 #define TSI_LOCAL_PROCESS_ID_PEER_PROPERTY "process_id"
  31
  32 /**
  33  * This method creates a local TSI handshaker instance.
  34  *
  35  * - is_client: boolean value indicating if the handshaker is used at the client
  36  *   (is_client = true) or server (is_client = false) side. The parameter is
  37  *   added for future extension.
  38  * - self: address of local TSI handshaker instance to be returned from the
  39  *   method.
  40  *
  41  * It returns TSI_OK on success and an error status code on failure.
  42  *
  43  * This handshaker is also being used as a minimalist handshaker for insecure
  44  * security connector. If this handshaker ever needs to do anything more that
  45  * does not fit with an insecure connector, we would need to add a separate
  46  * handshaker for insecure connectors.
  47  */
  48 tsi_result tsi_local_handshaker_create(bool is_client, tsi_handshaker** self);
  49
  50 #endif /* GRPC_CORE_TSI_LOCAL_TRANSPORT_SECURITY_H */