xref: /aosp_15_r20/external/tink/cc/signature/signature_config.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1 // Copyright 2017 Google Inc.
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 //
15 ///////////////////////////////////////////////////////////////////////////////
16 
17 #ifndef TINK_SIGNATURE_SIGNATURE_CONFIG_H_
18 #define TINK_SIGNATURE_SIGNATURE_CONFIG_H_
19 
20 #include "absl/base/macros.h"
21 #include "tink/util/status.h"
22 #include "proto/config.pb.h"
23 
24 namespace crypto {
25 namespace tink {
26 
27 ///////////////////////////////////////////////////////////////////////////////
28 // Static methods and constants for registering with the Registry
29 // all instances of signature key types supported in a particular
30 // release of Tink, i.e. key types that correspond to primitives
31 // PublicKeySign and PublicKeyVerify.
32 //
33 // To register all signature key types from the current Tink release
34 // one can do:
35 //
36 //   auto status = SignatureConfig::Register();
37 //
38 class SignatureConfig {
39  public:
40   // Registers PublicKeySign and PublicKeyVerify primitive wrappers, and key
41   // managers for all implementations of PublicKeySign and PublicKeyVerify from
42   // the current Tink release.
43   static crypto::tink::util::Status Register();
44 
45  private:
SignatureConfig()46   SignatureConfig() {}
47 };
48 
49 }  // namespace tink
50 }  // namespace crypto
51 
52 #endif  // TINK_SIGNATURE_SIGNATURE_CONFIG_H_
53