xref: /aosp_15_r20/external/tink/cc/partial_key_access.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1 // Copyright 2022 Google LLC
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_PARTIAL_KEY_ACCESS_H_
18 #define TINK_PARTIAL_KEY_ACCESS_H_
19 
20 #include "tink/partial_key_access_token.h"
21 
22 namespace crypto {
23 namespace tink {
24 
25 // Returns a `PartialKeyAccessToken`.
26 //
27 // Accessing parts of keys can produce unexpected incompatibilities:
28 // https://developers.google.com/tink/design/access_control#accessing_partial_keys
29 //
30 // This function can be used to access partial key material. Within Google,
31 // access to this function is restricted by the build system. Outside of Google,
32 // users can search their codebase for `GetPartialKeyAccess()` to find
33 // instances where it is used.
GetPartialKeyAccess()34 inline PartialKeyAccessToken GetPartialKeyAccess() {
35   return PartialKeyAccessToken();
36 }
37 
38 }  // namespace tink
39 }  // namespace crypto
40 
41 #endif  // TINK_PARTIAL_KEY_ACCESS_H_
42