xref: /aosp_15_r20/system/security/ondevice-signing/KeystoreKey.h (revision e1997b9af69e3155ead6e072d106a0077849ffba)

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * 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.
 */

#pragma once

#include <optional>

#include <android-base/macros.h>
#include <android-base/result.h>

#include <utils/StrongPointer.h>

#include <android/system/keystore2/IKeystoreService.h>

#include "KeystoreHmacKey.h"
#include "SigningKey.h"

class KeystoreKey : public SigningKey {
    using IKeystoreService = ::android::system::keystore2::IKeystoreService;
    using IKeystoreSecurityLevel = ::android::system::keystore2::IKeystoreSecurityLevel;
    using KeyDescriptor = ::android::system::keystore2::KeyDescriptor;
    using KeyMetadata = ::android::system::keystore2::KeyMetadata;

  public:
    virtual ~KeystoreKey(){};
    static android::base::Result<SigningKey*> getInstance(const std::string& signedPubKeyPath,
                                                          const android::String16& keyAlias,
                                                          int64_t KeyNspace, int keyBootLevel);

    virtual android::base::Result<std::string> sign(const std::string& message) const;
    virtual android::base::Result<std::vector<uint8_t>> getPublicKey() const;

  private:
    KeystoreKey(std::string signedPubKeyPath, const android::String16& keyAlias, int64_t keyNspace,
                int keyBootLevel);
    bool initialize();
    android::base::Result<std::vector<uint8_t>> verifyExistingKey();
    android::base::Result<std::vector<uint8_t>> createKey();
    android::base::Result<std::vector<uint8_t>> getOrCreateKey();

    KeyDescriptor mDescriptor;
    KeystoreHmacKey mHmacKey;
    android::sp<IKeystoreService> mService;
    android::sp<IKeystoreSecurityLevel> mSecurityLevel;
    std::vector<uint8_t> mPublicKey;

    std::string mSignedPubKeyPath;
    int mKeyBootLevel;
};