sgx_local_credentials_options.h

Go to the documentation of this file.

/*
 *
 * Copyright 2018 Asylo authors
 *
 * Licensed 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.
 *
 */

#ifndef ASYLO_GRPC_AUTH_SGX_LOCAL_CREDENTIALS_OPTIONS_H_
#define ASYLO_GRPC_AUTH_SGX_LOCAL_CREDENTIALS_OPTIONS_H_

#include "asylo/grpc/auth/enclave_credentials_options.h"

namespace asylo {

/// Creates options suitable for configuring a credential used in establishing a
/// bidirectionally-authenticated gRPC channel between two local SGX enclaves.
///
/// A credential configured with these options enforces bidirectional
/// authentication using SGX enclave code identity.
///
/// Sample usage for creating `::grpc::ChannelCredentials`:
///
/// ```
/// std::shared_ptr<::grpc::ChannelCredentials> creds =
///   EnclaveChannelCredentials(BidirectionalSgxLocalCredentialsOptions());
/// ```
///
/// Sample usage for creating `::grpc::ServerCredentials`:
///
/// ```
/// std::shared_ptr<::grpc::ServerCredentials> creds =
///   EnclaveServerCredentials(BidirectionalSgxLocalCredentialsOptions());
/// ```
///
/// \return Options used to configure gRPC credentials for a
///         bidirectionally-authenticated channel between SGX enclaves on the
///         same platform.
EnclaveCredentialsOptions BidirectionalSgxLocalCredentialsOptions();

/// Creates options suitable for configuring a credential used in establishing a
/// unidirectionally-authenticated gRPC channel between two local SGX enclaves.
///
/// A credential configured with these options enforces that the peer
/// authenticates using SGX enclave code identity.
///
/// Sample usage for creating `::grpc::ChannelCredentials`:
///
/// ```
/// std::shared_ptr<::grpc::ChannelCredentials> creds =
///   EnclaveChannelCredentials(PeerSgxLocalCredentialsOptions());
/// ```
///
/// Sample usage for creating `::grpc::ServerCredentials`:
///
/// ```
/// std::shared_ptr<::grpc::ServerCredentials> creds =
///   EnclaveServerCredentials(PeerSgxLocalCredentialsOptions());
/// ```
///
/// \return Options used to configure gRPC credentials for a channel that is
///         unidirectionally-authenticated on the peer's end using
///         SGX enclave code identity.
EnclaveCredentialsOptions PeerSgxLocalCredentialsOptions();

/// Creates options suitable for configuring a credential used in establishing a
/// unidirectionally-authenticated gRPC channel between two local SGX enclaves.
///
/// A credential configured with these options enforces that the credential
/// holder authenticates using SGX enclave code identity.
///
/// Sample usage for creating `::grpc::ChannelCredentials`:
///
/// ```
/// std::shared_ptr<::grpc::ChannelCredentials> creds =
///   EnclaveChannelCredentials(SelfSgxLocalCredentialsOptions());
/// ```
///
/// Sample usage for creating `::grpc::ServerCredentials`:
///
/// ```
/// std::shared_ptr<::grpc::ServerCredentials> creds =
///   EnclaveServerCredentials(SelfSgxLocalCredentialsOptions());
/// ```
///
/// \return Options used to configure gRPC credentials for a channel that is
///         unidirectionally-authenticated on the credential holder's end using
///         SGX enclave code identity.
EnclaveCredentialsOptions SelfSgxLocalCredentialsOptions();

}  // namespace asylo

#endif  // ASYLO_GRPC_AUTH_SGX_LOCAL_CREDENTIALS_OPTIONS_H_