gatekeeper_device 结构体参考文档
#include <
gatekeeper.h
>
数据字段 |
|
| hw_device_t | 常见 |
| int(* | enroll )(const struct gatekeeper_device *dev, uint32_t uid, const uint8_t *current_password_handle, uint32_t current_password_handle_length, const uint8_t *current_password, uint32_t current_password_length, const uint8_t *desired_password, uint32_t desired_password_length, uint8_t **enrolled_password_handle, uint32_t *enrolled_password_handle_length) |
| int(* | verify )(const struct gatekeeper_device *dev, uint32_t uid, uint64_t challenge, const uint8_t *enrolled_password_handle, uint32_t enrolled_password_handle_length, const uint8_t *provided_password, uint32_t provided_password_length, uint8_t **auth_token, uint32_t *auth_token_length, bool *request_reenroll) |
| int(* | delete_user )(const struct gatekeeper_device *dev, uint32_t uid) |
| int(* | delete_all_users )(const struct gatekeeper_device *dev) |
详细说明
定义位于文件 gatekeeper.h 的 41 行。
字段文档
| hw_device_t common |
网关设备的常用方法。如上所述，此成员必须是 keymaster_device 的第一个成员。
定义位于文件 gatekeeper.h 的 46 行。
| int(* delete_all_users)(const struct gatekeeper_device *dev) |
定义位于文件 gatekeeper.h 的 173 行。
| int(* delete_user)(const struct gatekeeper_device *dev, uint32_t uid) |
定义位于文件 gatekeeper.h 的 159 行。
| int(* enroll)(const struct gatekeeper_device *dev, uint32_t uid, const uint8_t *current_password_handle, uint32_t current_password_handle_length, const uint8_t *current_password, uint32_t current_password_length, const uint8_t *desired_password, uint32_t desired_password_length, uint8_t **enrolled_password_handle, uint32_t *enrolled_password_handle_length) |
使用仅用于注册身份验证因素数据的身份验证因素私钥注册 desired_password（应派生自用户选择的 PIN 码或密码）。
如果已注册密码，则应在 current_password_handle 中提供该密码，并在 current_password 中提供应与 current_password_handle 进行验证的当前密码。
参数：
- dev：指向 gatekeeper_device 的指针，通过对 gatekeeper_open 的调用获取
- uid：Android 用户标识符
- current_password_handle：用户要替换的当前已注册的密码句柄。如果目前没有注册的密码，则可能为 null。
- current_password_handle_length：current_password_handle 指向的缓冲区的长度（以字节为单位）。如果 current_password_handle 为 NULL，则必须为 0。
- current_password：用户的当前密码（纯文本）。如果提供，则必须与 current_password_handle 进行验证。
- current_password_length：current_password 指向的缓冲区的大小（以字节为单位）。如果 current_password 为 NULL，则必须为 0。
- desired_password：用户希望注册的纯文本新密码。不得为 NULL。
- desired_password_length：desired_password 所指向的缓冲区的长度（以字节为单位）。
- enrolled_password_handle：成功时，系统会分配一个缓冲区，其中包含引用 desired_password 中提供的密码的新密码句柄。此缓冲区可在后续调用注册或验证时使用。调用方负责通过调用 delete[] 来取消分配此缓冲区
- enrolled_password_handle_length：指向此函数分配的缓冲区的长度（以字节为单位）的指针，该长度由 *enrolled_password_handle_length 指向。
返回值：
- 成功时为 0
- 失败时，错误代码小于 0；或者
- 超时值 T > 0，表示在 T 毫秒过后才能重试调用。
发生错误时，系统不会分配 enrolled_password_handle。
定义位于文件 gatekeeper.h 的 91 行。
| int(* verify)(const struct gatekeeper_device *dev, uint32_t uid, uint64_t challenge, const uint8_t *enrolled_password_handle, uint32_t enrolled_password_handle_length, const uint8_t *provided_password, uint32_t provided_password_length, uint8_t **auth_token, uint32_t *auth_token_length, bool *request_reenroll) |
验证 provided_password 是否与 enrolled_password_handle 相符。
此模块的实现可能会保留此调用的结果，以证明身份验证的最新性。
成功时，将验证令牌的地址写入 auth_token，以便向其他受信任服务证明密码验证。客户端可以为此值传递 NULL。
参数：
- dev：指向 gatekeeper_device 的指针，通过对 gatekeeper_open 的调用获取
- uid：Android 用户标识符
- challenge：用于进行身份验证的可选质询，或 0。当单独的身份验证器请求密码验证时，或用于事务性密码身份验证时使用。
- enrolled_password_handle：用户希望验证的当前已注册的密码句柄。
- enrolled_password_handle_length：enrolled_password_handle 指向的缓冲区的长度（以字节为单位）
- provided_password：要与 enrolled_password_handle 进行验证的明文密码
- provided_password_length：provided_password 指向的缓冲区的长度（以字节为单位）
- auth_token：成功后，系统会将包含此验证所产生的身份验证令牌的缓冲区分配给 *auth_token。调用方负责通过调用 delete[] 来取消分配此内存
- auth_token_length：成功时，分配给 *auth_token 的身份验证令牌的长度（以字节为单位）将分配给 *auth_token_length
- request_reenroll：由于版本变更，向上层发出重新注册已验证密码的请求。如果验证失败，则不会设置。
返回值：
- 成功时为 0
- 失败时，错误代码小于 0；或者
- 超时值 T > 0，表示在 T 毫秒过后才能重试调用。发生错误时，系统不会分配身份验证令牌
定义位于文件 gatekeeper.h 的 141 行 。
此结构体的文档是根据以下文件生成的：
- hardware/libhardware/include/hardware/ gatekeeper.h