keymaster2_device Yapı Referansı
#include <
keymaster2.h
>
Ayrıntılı Açıklama
Keymaster2 cihaz tanımı
Tanımı, keymaster2.h dosyasının 28. satırı .
Alan Belgeleri
keymaster_error_t (* abort)(const struct keymaster2_device *dev, keymaster_operation_handle_t operation_handle) |
begin()
ile başlatılan bir kriptografik işlemi iptal ederek tüm dahili kaynakları serbest bırakır ve
operation_handle
değerini geçersiz kılar.
Tanımı, keymaster2.h dosyasının 415 satırı
keymaster_error_t (* add_rng_entropy)(const struct keymaster2_device *dev, const uint8_t *data, size_t data_length) |
Anahtar yöneticisi tarafından kullanılan RNG'ye entropi ekler. Bu yöntemle eklenen entropi, kullanılan tek entropi kaynağı olmayacaktır. Karıştırma işlevinin güvenli olması gerekir. Yani, RNG'ye saldırganın tahmin edemeyeceği (veya kontrol edemeyeceği) herhangi bir veri eklenirse (herhangi bir kaynaktan) RNG çıkışı rastgele ile ayırt edilemez. Bu nedenle, herhangi bir kaynaktan gelen entropi iyiyse çıkış da iyi olur.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] aktarma Karıştırılacak rastgele veriler. [in] data_length Uzunluğu data
.
Tanımı, keymaster2.h dosyasının 74. satırı içindedir.
keymaster_error_t (* attest_key)(const struct keymaster2_device *dev, const keymaster_key_blob_t *key_to_attest, const keymaster_key_param_set_t *attest_params, keymaster_cert_chain_t *cert_chain) |
Anahtar efendisinde
key_to_attest
bulunduğunu doğrulayan imzalı bir X.509 sertifika zinciri oluşturur (TODO(swillden): Sertifika içeriğini daha ayrıntılı şekilde açıklayın). Sertifika, 1.3.6.1.4.1.11129.2.1.17 OID'sine sahip bir uzantı ve anahtar açıklamasını içeren <TODO:swillden – insert link here> adresinde tanımlanan değeri içerir.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] key_to_attest Onay sertifikasının oluşturulacağı anahtar yöneticisi anahtarı. [in] attest_params Onay işleminin nasıl yapılacağını tanımlayan parametreler. Şu anda tek parametre KM_TAG_ALGORITHM'dir. Bu parametre KM_ALGORITHM_EC veya KM_ALGORITHM_RSA olmalıdır. Bu, sertifika imzalamak için hangi temel hazır sertifika anahtarının kullanılacağını seçer. [out] cert_chain DER kodlamalı X.509 sertifikaları dizisi. İlki key_to_attest
alanına ait sertifikadır. Geri kalan girişler köke geri bağlanır. Arayan, sahipliği alır ve keymaster_free_cert_chain ile alanı ayırmalıdır.
Tanımı, keymaster2.h dosyasının 239 satırı
keymaster_error_t (* begin)(const struct keymaster2_device *dev, keymaster_purpose_t purpose, const keymaster_key_blob_t *key, const keymaster_key_param_set_t *in_params, keymaster_key_param_set_t *out_params, keymaster_operation_handle_t *operation_handle) |
Belirtilen anahtarı kullanarak bir şifreleme işlemi başlatır. Her şey yolunda giderse begin() KM_ERROR_OK değerini döndürür ve update() , finish() veya abort() işlevlerinin sonraki çağrılarına iletilmesi gereken bir işlem işleyicisi oluşturur.
Anahtar yöneticisi uygulamasının tüm dahili işlem durumunu temizlemesine izin vermek için her begin() çağrısının, finish() veya abort() çağrısıyla eşleştirilmesi çok önemlidir. Bu yapılmazsa dahili durum alanı veya diğer dahili kaynaklar sızabilir ve sonunda işlem alanı bittiğinde begin() KM_ERROR_TOO_MANY_OPERATIONS değerinin döndürülmesine neden olabilir. begin() , update() veya finish() işlevlerinden elde edilen KM_ERROR_OK dışındaki tüm sonuçlar işlemi dolaylı olarak iptal eder. Bu durumda abort() işlevinin çağrılmasına gerek yoktur (ve çağrılırsa KM_ERROR_INVALID_OPERATION_HANDLE döndürülür).
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] amaç İşlemin amacı (KM_PURPOSE_ENCRYPT, KM_PURPOSE_DECRYPT, KM_PURPOSE_SIGN veya KM_PURPOSE_VERIFY seçeneklerinden biri). AEAD modlarında şifreleme ve şifre çözme işlemlerinin sırasıyla imzalama ve doğrulama anlamına geldiğini ancak KM_PURPOSE_ENCRYPT ve KM_PURPOSE_DECRYPT olarak belirtilmesi gerektiğini unutmayın. [in] anahtar İşlem için kullanılacak anahtar. key
,purpose
ile uyumlu bir amaca sahip olmalı ve tüm kullanım şartları karşılanmış olmalıdır. Aksi takdirde begin() , uygun bir hata kodu döndürür.[in] in_params İşlem için ek parametreler. Bu genellikle KM_TAG_AUTH_TOKEN ile kimlik doğrulama verileri sağlamak için kullanılır. Oluşturma sırasında KM_TAG_APPLICATION_ID veya KM_TAG_APPLICATION_DATA sağlandıysa burada da sağlanmalıdır. Aksi takdirde işlem KM_ERROR_INVALID_KEY_BLOB hatasıyla başarısız olur. KM_TAG_CALLER_NONCE ile oluşturulan anahtarlarda, tek seferlik veya IV gerektiren işlemler için in_params, KM_TAG_NONCE etiketi içerebilir. [out] out_params Çıkış parametreleri. İşlem başlatma işleminden ek veriler döndürmek için kullanılır. Özellikle, IV veya tek seferlik şifre oluşturan işlemlerden IV veya tek seferlik şifre döndürmek için kullanılır. Çağırıcı, çıkış parametreleri dizisinin sahipliğini alır ve keymaster_free_param_set() ile diziyi serbest bırakmalıdır. Çıkış parametresi beklenmiyorsa out_params NULL olarak ayarlanabilir. out_params NULL ise ve çıkış parametreleri oluşturulursa begin() KM_ERROR_OUTPUT_PARAMETER_NULL değerini döndürür. [out] operation_handle Yeni oluşturulan işlem işleyicisi. update() , finish() veya abort() işlevlerine geçirilmelidir. operation_handle NULL ise begin() KM_ERROR_OUTPUT_PARAMETER_NULL değerini döndürür.
Tanımı, keymaster2.h dosyasının 332 satırı
struct hw_device_t common |
Anahtar yöneticisi cihazının yaygın yöntemleri. Bu yapının kullanıcıları, hw_device_t bir keymaster_device'e referans verdiği bilinen bağlamlarda keymaster_device işaretçisine bir hw_device_t atayacağından bu, keymaster_device'in ilk üyesi olmalıdır.
Tanımı, keymaster2.h dosyasının 35. satırı içindedir.
keymaster_error_t (* configure)(const struct keymaster2_device *dev, const keymaster_key_param_set_t *params) |
Anahtar yöneticisini yapılandırır. Bu yöntem, cihaz açıldıktan sonra ve kullanılmadan önce bir kez çağrılmalıdır. Anahtar yöneticisine KM_TAG_OS_VERSION ve KM_TAG_OS_PATCHLEVEL değerlerini sağlamak için kullanılır. Bu yöntem çağrılana kadar diğer tüm yöntemler KM_ERROR_KEYMASTER_NOT_CONFIGURED değerini döndürür. Bu yöntemle sağlanan değerler, anahtar yöneticisi tarafından yalnızca önyükleme başına bir kez kabul edilir. Sonraki çağrılar KM_ERROR_OK değerini döndürür ancak hiçbir işlem yapmaz.
Anahtar yöneticisi uygulaması güvenli donanımdaysa ve sağlanan OS sürümü ve yama düzeyi değerleri, önyükleyici tarafından güvenli donanıma sağlanan değerlerle eşleşmiyorsa (veya önyükleyici değer sağlamadıysa) bu yöntem KM_ERROR_INVALID_ARGUMENT değerini döndürür ve diğer tüm yöntemler KM_ERROR_KEYMASTER_NOT_CONFIGURED değerini döndürmeye devam eder.
Tanımı, keymaster2.h dosyasının 58. satırı sırasındadır.
void* bağlamı |
Tanımı, keymaster2.h dosyasının 37. satırı sırasındadır.
keymaster_error_t (* delete_all_keys)(const struct keymaster2_device *dev) |
Donanım anahtar deposundaki tüm anahtarları siler. Anahtar anahtar kutusu tamamen sıfırlandığında kullanılır. Bu işlev çağrıldıktan sonra, daha önce oluşturulmuş veya içe aktarılmış anahtar blob'larını işlemlerde kullanmak mümkün olmaz.
Bu işlev isteğe bağlıdır ve uygulanmazsa NULL olarak ayarlanmalıdır.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı.
Tanımı, keymaster2.h dosyasının 288 satırı
keymaster_error_t (* delete_key)(const struct keymaster2_device *dev, const keymaster_key_blob_t *key) |
Anahtar blob'uyla ilişkili anahtarı veya anahtar çiftini siler. Bu işlev çağrıldıktan sonra anahtar başka işlemler için kullanılamaz. Yabancı güven köklerinden gelen anahtarlara uygulanabilir (mevcut güven kökü altında kullanılamayan anahtarlar).
Bu işlev isteğe bağlıdır ve uygulanmazsa NULL olarak ayarlanmalıdır.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] anahtar Silecek anahtar.
Tanım, keymaster2.h dosyasının 276 satırı
keymaster_error_t (* export_key)(const struct keymaster2_device *dev, keymaster_key_format_t export_format, const keymaster_key_blob_t *key_to_export, const keymaster_blob_t *client_id, const keymaster_blob_t *app_data, keymaster_blob_t *export_data) |
Belirtilen biçimde bir bayt dizisi döndürerek ortak veya simetrik bir anahtarı dışa aktarır.
Simetrik anahtar dışa aktarma işlemine yalnızca anahtar KM_TAG_EXPORTABLE ile oluşturulduysa ve yalnızca anahtar kullanımıyla ilgili tüm koşullar (ör. kimlik doğrulama) karşılandıysa izin verilir.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] export_format Anahtarı dışa aktarmak için kullanılacak biçim. [in] key_to_export Dışa aktarılacak anahtar. [in] client_id Anahtar oluşturma sırasında KM_TAG_APPLICATION_ID (varsa) alanında sağlanan blob ile eşleşmesi gereken istemci kimliği blob'u. [in] app_data Anahtar oluşturma sırasında KM_TAG_APPLICATION_DATA içinde sağlanan blob ile eşleşmesi gereken uygulama verisi blob'u (varsa). [out] export_data Dışa aktarılan anahtar materyali. Arayan kişi sahipliği üstlenir.
Tanımı, keymaster2.h dosyasının 213 satırı
keymaster_error_t (* finish)(const struct keymaster2_device *dev, keymaster_operation_handle_t operation_handle, const keymaster_key_param_set_t *in_params, const keymaster_blob_t *input, const keymaster_blob_t *signature, keymaster_key_param_set_t *out_params, keymaster_blob_t *output) |
begin()
ile başlayan bir kriptografik işlemi tamamlar ve
operation_handle
değerini geçersiz kılar.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] operation_handle begin() tarafından döndürülen işlem mülkünü temsil eder. . Bu herkese açık kullanıcı adı geçersiz hale gelir. [in] in_params İşlem için ek parametreler. AEAD modlarında bu, KM_TAG_ADDITIONAL_DATA parametresini belirtmek için kullanılır ancak yalnızca update() işlevine giriş verisi sağlanmamışsa kullanılır. [in] giriş begin() çağrısında belirlenen parametrelere göre işlenecek veriler. finish() sağlanan tüm verileri kullanmalıdır veya KM_ERROR_INVALID_INPUT_LENGTH değerini döndürmelidir. [in] signature begin() çağrısında belirtilen amaç KM_PURPOSE_VERIFY ise doğrulanacak imza. [out] output Varsa çıkış verileri. Arayan, ayrılan arabelleğin sahipliğini üstlenir.
Tamamlanan işlem bir imza doğrulaması veya AEAD modunda şifre çözme işlemiyse ve doğrulama başarısız olursa finish() KM_ERROR_VERIFICATION_FAILED değerini döndürür.
Tanımı, keymaster2.h dosyasının 405 satırı
uint32_t işaretleri |
keymaster_common.h dosyasında keymaster0_devices::flags için tanımlanan işaretlere bakın. Yalnızca geriye dönük uyumluluk için kullanılır. keymaster2 donanım cihazları bunu sıfıra ayarlamalıdır.
Tanımı, keymaster2.h dosyasının 43. satırı sırasındadır.
keymaster_error_t (* generate_key)(const struct keymaster2_device *dev, const keymaster_key_param_set_t *params, keymaster_key_blob_t *key_blob, keymaster_key_characteristics_t *characteristics) |
Bir anahtar veya anahtar çifti oluşturur ve bir anahtar blob'u ve/veya anahtarın açıklamasını döndürür.
Anahtar oluşturma parametreleri,
params
bölümünde sağlanan anahtar yöneticisi etiketi/değer çiftleri olarak tanımlanır. Tam liste için keymaster_tag_t öğesine bakın. Yararlı anahtarlar oluşturmak için her zaman gereken bazı değerler şunlardır:
- KM_TAG_ALGORITHM;
- KM_TAG_PURPOSE; ve
- (KM_TAG_USER_SECURE_ID ve KM_TAG_USER_AUTH_TYPE) veya KM_TAG_NO_AUTH_REQUIRED.
KM_TAG_NO_AUTH_REQUIRED mevcut olmadığı sürece KM_TAG_AUTH_TIMEOUT genellikle belirtilmelidir. Aksi takdirde kullanıcının her kullanım için kimlik doğrulaması yapması gerekir.
KM_TAG_BLOCK_MODE, KM_TAG_PADDING, KM_TAG_MAC_LENGTH ve KM_TAG_DIGEST, bunları gerektiren algoritmalar için belirtilmelidir.
Aşağıdaki etiketler belirtilemez; değerleri uygulama tarafından sağlanır.
- KM_TAG_ORIGIN,
- KM_TAG_ROLLBACK_RESISTANT,
- KM_TAG_CREATION_DATETIME
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] params Anahtar oluşturma parametresi dizisi [out] key_blob oluşturulan anahtarı döndürür. key_blob
NULL olmamalıdır. Çağıran, key_blob->key_material sahipliğini üstlenir ve free() işlevini çağırarak bu anahtarı serbest bırakmalıdır.[out] özellikler NULL değilse oluşturulan anahtarın özelliklerini döndürür. NULL değilse arayan sahipliği üstlenir ve keymaster_free_characteristics() ile alanı ayırmalıdır. KM_TAG_ROOT_OF_TRUST, KM_TAG_APPLICATION_ID ve KM_TAG_APPLICATION_DATA parametrelerinin hiçbir zaman döndürülmediğini unutmayın.
Tanımı, keymaster2.h dosyasının 112 satırı
keymaster_error_t (* get_key_characteristics)(const struct keymaster2_device *dev, const keymaster_key_blob_t *key_blob, const keymaster_blob_t *client_id, const keymaster_blob_t *app_data, keymaster_key_characteristics_t *characteristics) |
Belirtilen anahtarın özelliklerini döndürür veya key_blob geçersizse KM_ERROR_INVALID_KEY_BLOB değerini döndürür (uygulamalar, anahtarın bütünlüğünü tamamen doğrulamalıdır). client_id ve app_data, anahtar oluşturulurken veya içe aktarılırken sağlanan kimlik ve veriler olmalıdır. Aksi takdirde, KM_TAG_APPLICATION_ID ve/veya KM_TAG_APPLICATION_DATA oluşturulma sırasında sağlanmadıysa boş olmalıdır. Bu değerler, döndürülen özelliklere dahil edilmez. Çağıran, ayrılan özellikler nesnesinin sahipliğini üstlenir. Bu nesne, keymaster_free_characteristics() ile ayrılmalıdır.
KM_TAG_APPLICATION_ID ve KM_TAG_APPLICATION_DATA parametrelerinin hiçbir zaman döndürülmediğini unutmayın.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] key_blob Özelliklerin alınacağı anahtar. [in] client_id İstemci kimliği verileri veya ilişkili bir veri yoksa NULL. [in] app_id Uygulama verileri veya ilişkili veri yoksa NULL. [out] özellikler Temel özellikler. NULL olmamalıdır. Çağıran, içeriğin sahipliğini üstlenir ve keymaster_free_characteristics() ile alanı ayırmalıdır.
Tanımı, keymaster2.h dosyasının 139 satırı
keymaster_error_t (* import_key)(const struct keymaster2_device *dev, const keymaster_key_param_set_t *params, keymaster_key_format_t key_format, const keymaster_blob_t *key_data, keymaster_key_blob_t *key_blob, keymaster_key_characteristics_t *characteristics) |
Bir anahtarı veya anahtar çiftini içe aktararak bir anahtar blob'u ve/veya anahtarın açıklamasını döndürür.
Anahtar içe aktarma parametrelerinin çoğu, "params" içinde sağlanan anahtar yöneticisi etiketi/değer çiftleri olarak tanımlanır. Tam liste için keymaster_tag_t öğesine bakın. Yararlı anahtarların içe aktarılması için her zaman gereken değerler şunlardır:
- KM_TAG_ALGORITHM;
- KM_TAG_PURPOSE; ve
- (KM_TAG_USER_SECURE_ID ve KM_TAG_USER_AUTH_TYPE) veya KM_TAG_NO_AUTH_REQUIRED.
KM_TAG_AUTH_TIMEOUT genellikle belirtilmelidir. Belirtilmezse kullanıcının her kullanım için kimliğini doğrulaması gerekir.
Aşağıdaki etiketler belirtilmezse varsayılan değerleri alır:
- KM_TAG_KEY_SIZE, varsayılan olarak sağlanan anahtarın boyutuna ayarlanır.
- KM_TAG_RSA_PUBLIC_EXPONENT, varsayılan olarak sağlanan anahtardaki değere (RSA anahtarları için) ayarlanır.
Aşağıdaki etiketler belirtilemez; değerleri uygulama tarafından sağlanır.
- KM_TAG_ORIGIN,
- KM_TAG_ROLLBACK_RESISTANT,
- KM_TAG_CREATION_DATETIME
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] params İçe aktarılan anahtarı tanımlayan parametreler. [in] params_count params
içindeki girişlerin sayısıdır.[in] key_format key_data parametresindeki anahtar verilerinin biçimini belirtir. [out] key_blob Saydam olmayan anahtar blob'unu döndürmek için kullanılır. NULL olmamalıdır. Arayan, içerdiği key_material öğesinin sahipliğini üstlenir. [out] özellikler İçe aktarılan anahtarın özelliklerini döndürmek için kullanılır. NULL olabilir. Bu durumda hiçbir özellik döndürülmez. NULL değilse çağıran, içeriğin sahipliğini üstlenir ve keymaster_free_characteristics() ile ayırma işlemini gerçekleştirmelidir. KM_TAG_APPLICATION_ID ve KM_TAG_APPLICATION_DATA parametrelerinin hiçbir zaman döndürülmediğini unutmayın.
Tanımı, keymaster2.h dosyasının 186 satırı
keymaster_error_t (* update)(const struct keymaster2_device *dev, keymaster_operation_handle_t operation_handle, const keymaster_key_param_set_t *in_params, const keymaster_blob_t *input, size_t *input_consumed, keymaster_key_param_set_t *out_params, keymaster_blob_t *output) |
begin() ile başlatılan devam eden bir kriptografik işleme veri sağlar ve bu işlemden çıkış alabilir.
operation_handle geçersizse update() KM_ERROR_INVALID_OPERATION_HANDLE döndürülür.
update() veri arabelleğinde sağlanan verilerin tamamını tüketmeyebilir. update() *data_consumed içinde tüketilen miktarı döndürür. Arayan, kullanılmayan verileri sonraki bir çağrıda sağlamalıdır.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] operation_handle begin() tarafından döndürülen işlem mülkünü temsil eder. . [in] in_params İşlem için ek parametreler. AEAD modlarında bu, KM_TAG_ADDITIONAL_DATA'yı belirtmek için kullanılır. update() çağrısında birden fazla kez ek veri sağlanabileceğini ancak bunun yalnızca giriş verileri sağlanana kadar yapılabileceğini unutmayın. [in] giriş begin() çağrısında belirlenen parametrelere göre işlenecek veriler. update() işlevinin, sağlanan verilerin tamamını kullanabileceğini veya kullanamayacağını unutmayın. input_consumed
bölümüne göz atın.[out] input_consumed update() tarafından tüketilen veri miktarı . Bu tutar, sağlanan tutardan azsa arayan, kalan tutarı update() çağrısında sağlamalıdır. [out] out_params Çıkış parametreleri. İşlemden ek veri döndürmek için kullanılır. Çağırıcı, çıkış parametreleri dizisinin sahipliğini alır ve keymaster_free_param_set() ile diziyi serbest bırakmalıdır. Çıkış parametresi beklenmiyorsa out_params NULL olarak ayarlanabilir. out_params NULL ise ve çıkış parametreleri oluşturulursa begin() KM_ERROR_OUTPUT_PARAMETER_NULL değerini döndürür. [out] output Varsa çıkış verileri. Arayan, ayrılan arabelleğin sahipliğini üstlenir. output NULL olmamalıdır.
update() işlevinin herhangi bir çıkış sağlamayabileceğini unutmayın. Bu durumda output->data_length sıfır olur ve output->data NULL veya sıfır uzunlukta olabilir (bu nedenle, çağıran her zaman free() işlevini çağırmalıdır).
Tanım, keymaster2.h dosyasının 376 satırı içindedir.
keymaster_error_t (* upgrade_key)(const struct keymaster2_device *dev, const keymaster_key_blob_t *key_to_upgrade, const keymaster_key_param_set_t *upgrade_params, keymaster_key_blob_t *upgraded_key) |
Eski bir anahtarı yeni sürüme geçirir. Anahtarlar iki şekilde "eski" hale gelebilir: Anahtar yöneticisi yeni bir sürüme yükseltilebilir veya sistem, OS sürümünü ve/veya yama düzeyini geçersiz kılacak şekilde güncellenebilir. Her iki durumda da eski bir anahtarı kullanma girişimleri, anahtar yöneticisinin KM_ERROR_KEY_REQUIRES_UPGRADE değerini döndürmesine neden olur. Ardından, anahtarı yükseltmek için bu yöntem çağrılmalıdır.
- Parametreler
-
[in] dev Anahtar yöneticisi cihaz yapısı. [in] key_to_upgrade Yükseltilecek anahtar yöneticisi anahtarı. [in] upgrade_params Yükseltme işleminin tamamlanması için gereken parametreler. Özellikle, anahtar için tanımlanmışlarsa KM_TAG_APPLICATION_ID ve KM_TAG_APPLICATION_DATA gereklidir. [out] upgraded_key Yükseltilmiş anahtar blob'u.
Tanımı, keymaster2.h dosyasının 260 satırı
Bu yapının dokümanları aşağıdaki dosyadan oluşturulmuştur:
- hardware/libhardware/include/hardware/ keymaster2.h