credentialhelper/
credential_helper.rs

1// Copyright 2023 EngFlow, Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use crate::GetCredentialsRequest;
16use crate::GetCredentialsResponse;
17
18/// Represents a Credential Helper.
19///
20/// Note: we intentionally require all implementations of `CredentialHelper` to be thread- and async safe.
21pub trait CredentialHelper: Send + Sync {
22    #[allow(unused_variables)]
23    fn get_credentials(
24        &self,
25        request: GetCredentialsRequest,
26        additional_parameters: Vec<String>,
27    ) -> Result<GetCredentialsResponse, String> {
28        return Err("Credential Helper does not support command 'get'".to_string());
29    }
30}