xref: /aosp_15_r20/external/tink/cc/signature/ed25519_private_key.h (revision e7b1675dde1b92d52ec075b0a92829627f2c52a5)
1*e7b1675dSTing-Kang Chang // Copyright 2023 Google LLC
2*e7b1675dSTing-Kang Chang //
3*e7b1675dSTing-Kang Chang // Licensed under the Apache License, Version 2.0 (the "License");
4*e7b1675dSTing-Kang Chang // you may not use this file except in compliance with the License.
5*e7b1675dSTing-Kang Chang // You may obtain a copy of the License at
6*e7b1675dSTing-Kang Chang //
7*e7b1675dSTing-Kang Chang //      http://www.apache.org/licenses/LICENSE-2.0
8*e7b1675dSTing-Kang Chang //
9*e7b1675dSTing-Kang Chang // Unless required by applicable law or agreed to in writing, software
10*e7b1675dSTing-Kang Chang // distributed under the License is distributed on an "AS IS" BASIS,
11*e7b1675dSTing-Kang Chang // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*e7b1675dSTing-Kang Chang // See the License for the specific language governing permissions and
13*e7b1675dSTing-Kang Chang // limitations under the License.
14*e7b1675dSTing-Kang Chang //
15*e7b1675dSTing-Kang Chang ////////////////////////////////////////////////////////////////////////////////
16*e7b1675dSTing-Kang Chang 
17*e7b1675dSTing-Kang Chang #ifndef TINK_SIGNATURE_ED25519_PRIVATE_KEY_H_
18*e7b1675dSTing-Kang Chang #define TINK_SIGNATURE_ED25519_PRIVATE_KEY_H_
19*e7b1675dSTing-Kang Chang 
20*e7b1675dSTing-Kang Chang #include "tink/partial_key_access_token.h"
21*e7b1675dSTing-Kang Chang #include "tink/restricted_data.h"
22*e7b1675dSTing-Kang Chang #include "tink/signature/ed25519_public_key.h"
23*e7b1675dSTing-Kang Chang #include "tink/signature/signature_private_key.h"
24*e7b1675dSTing-Kang Chang #include "tink/util/statusor.h"
25*e7b1675dSTing-Kang Chang 
26*e7b1675dSTing-Kang Chang namespace crypto {
27*e7b1675dSTing-Kang Chang namespace tink {
28*e7b1675dSTing-Kang Chang 
29*e7b1675dSTing-Kang Chang class Ed25519PrivateKey : public SignaturePrivateKey {
30*e7b1675dSTing-Kang Chang  public:
31*e7b1675dSTing-Kang Chang   // Copyable and movable.
32*e7b1675dSTing-Kang Chang   Ed25519PrivateKey(const Ed25519PrivateKey& other) = default;
33*e7b1675dSTing-Kang Chang   Ed25519PrivateKey& operator=(const Ed25519PrivateKey& other) = default;
34*e7b1675dSTing-Kang Chang   Ed25519PrivateKey(Ed25519PrivateKey&& other) = default;
35*e7b1675dSTing-Kang Chang   Ed25519PrivateKey& operator=(Ed25519PrivateKey&& other) = default;
36*e7b1675dSTing-Kang Chang 
37*e7b1675dSTing-Kang Chang   // Creates a new Ed25519 private key from `private_key_bytes`. Returns an
38*e7b1675dSTing-Kang Chang   // error if `public_key` does not belong to the same key pair as
39*e7b1675dSTing-Kang Chang   // `private_key_bytes`.
40*e7b1675dSTing-Kang Chang   static util::StatusOr<Ed25519PrivateKey> Create(
41*e7b1675dSTing-Kang Chang       const Ed25519PublicKey& public_key,
42*e7b1675dSTing-Kang Chang       const RestrictedData& private_key_bytes, PartialKeyAccessToken token);
43*e7b1675dSTing-Kang Chang 
GetPrivateKeyBytes(PartialKeyAccessToken token)44*e7b1675dSTing-Kang Chang   const RestrictedData& GetPrivateKeyBytes(PartialKeyAccessToken token) const {
45*e7b1675dSTing-Kang Chang     return private_key_bytes_;
46*e7b1675dSTing-Kang Chang   }
47*e7b1675dSTing-Kang Chang 
GetPublicKey()48*e7b1675dSTing-Kang Chang   const Ed25519PublicKey& GetPublicKey() const override { return public_key_; }
49*e7b1675dSTing-Kang Chang 
50*e7b1675dSTing-Kang Chang   bool operator==(const Key& other) const override;
51*e7b1675dSTing-Kang Chang 
52*e7b1675dSTing-Kang Chang  private:
Ed25519PrivateKey(const Ed25519PublicKey & public_key,const RestrictedData & private_key_bytes)53*e7b1675dSTing-Kang Chang   explicit Ed25519PrivateKey(const Ed25519PublicKey& public_key,
54*e7b1675dSTing-Kang Chang                              const RestrictedData& private_key_bytes)
55*e7b1675dSTing-Kang Chang       : public_key_(public_key), private_key_bytes_(private_key_bytes) {}
56*e7b1675dSTing-Kang Chang 
57*e7b1675dSTing-Kang Chang   Ed25519PublicKey public_key_;
58*e7b1675dSTing-Kang Chang   RestrictedData private_key_bytes_;
59*e7b1675dSTing-Kang Chang };
60*e7b1675dSTing-Kang Chang 
61*e7b1675dSTing-Kang Chang }  // namespace tink
62*e7b1675dSTing-Kang Chang }  // namespace crypto
63*e7b1675dSTing-Kang Chang 
64*e7b1675dSTing-Kang Chang #endif  // TINK_SIGNATURE_ED25519_PRIVATE_KEY_H_
65