From d7c7519a28a1310759a57410fc52eed50a068381 Mon Sep 17 00:00:00 2001 From: l00520400 Date: Tue, 11 Jan 2022 13:13:12 +0800 Subject: [PATCH] update readme Signed-off-by: l00520400 --- README.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d3b376cb0..7e620ce5c 100644 --- a/README.md +++ b/README.md @@ -5,31 +5,30 @@ - [目录](#section119744591305) - [使用](#section137768191623) - [接口说明](#section1551164914237) - - [使用说明](#section129654513264) - [相关仓](#section1371113476307) ## 简介 ATM是OpenHarmony上基于AccessToken构建的统一的应用权限管理能力。 -应用的Accesstoken信息主要包括应用身份标识APPID、用户ID，应用分身索引、应用APL等级、应用权限信息等。每个应用的Accestoken信息由一个32bits的设备内唯一标识符tokenID来标识。 +应用的Accesstoken信息主要包括应用身份标识APPID、用户ID，应用分身索引、应用APL等级、应用权限信息等。每个应用的Accestoken信息由一个32bits的设备内唯一标识符TokenID来标识。 ATM模块主要提供如下功能： -- 提供基于tokenID的应用权限校验机制，应用访问敏感数据或者API时可以检查是否有对应的权限； -- 提供基于tokenID的Accestoken信息查询，应用可以根据tokenID查询自身的APL等级等信息； +- 提供基于TokenID的应用权限校验机制，应用访问敏感数据或者API时可以检查是否有对应的权限。 +- 提供基于TokenID的Accestoken信息查询，应用可以根据tokenID查询自身的APL等级等信息。 ## 缩略词 - AT: AccessToken, 访问凭据 - ATM: AccessTokenManager, 访问凭据管理 - API： Application Programming Interface, 应用程序接口 -- APL: API Ability Privilege Level, 权限访问控制列表 +- APL: API Ability Privilege Level, 元能力权限等级 - APPID: APP identity，应用身份标识 -- tokenID: token identity，凭据身份标识 +- TokenID: Token identity，凭据身份标识 ## 目录 ``` /base/security/access_token -├── frameworks # 框架层，基础功能代码存放目录，被interfaces和services使用 +├── frameworks # 框架层，基础功能代码存放目录 │ ├── accesstoken # Accesstoken管理框架代码存放目录 │ ├── tokensync # Accesstoken信息同步框架代码存放目录 │ └── common # 框架公共代码存放目录 @@ -45,13 +44,31 @@ ATM模块主要提供如下功能： ## 使用 ### 接口说明 -### 使用说明 -1. xxxx -2. xxxx -3. xxxx +| **接口申明** | **接口描述** | +| --- | --- | +| AccessTokenIDEx AllocHapToken(const HapInfoParams& info, const HapPolicyParams& policy); | 为应用进程分配一个tokenID | +| AccessTokenID AllocLocalTokenID(const std::string& remoteDeviceID, AccessTokenID remoteTokenID); | 为远端设备的应用进程分配一个本地tokenID | +| int UpdateHapToken(AccessTokenID tokenID, const std::string& appIDDesc, const HapPolicyParams& policy); | 更新tokenId对应的tokenInfo信息 | +| int DeleteToken(AccessTokenID tokenID); | 删除应用tokenID及其对应的tokenInfo信息 | +| int GetTokenType(AccessTokenID tokenID); | 查询指定tokenID的类型 | +| int CheckNativeDCap(AccessTokenID tokenID, const std::string& dcap); | 检测指定tokenID对应的native进程是否具有指定的分布式能力 | +| AccessTokenID GetHapTokenID(int userID, const std::string& bundleName, int instIndex); | 查询指定应用的tokenId | +| int GetHapTokenInfo(AccessTokenID tokenID, HapTokenInfo& hapTokenInfoRes); | 查询指定tokenID对应的hap包的tokenInfo信息 | +| int GetNativeTokenInfo(AccessTokenID tokenID, NativeTokenInfo& nativeTokenInfoRes); | 查询指定tokenID对应的native的tokenInfo信息 | +| int VerifyAccessToken(AccessTokenID tokenID, const std::string& permissionName); | 检查指定tokenID是否具有指定权限 | +| int GetDefPermission(const std::string& permissionName, PermissionDef& permissionDefResult); | 查询指定权限的权限定义信息 | +| int GetDefPermissions(AccessTokenID tokenID, std::vector& permList); | 查询指定tokenID对应的hap包的权限定义集合 | +| int GetReqPermissions(AccessTokenID tokenID, std::vector& reqPermList, bool isSystemGrant); | 查询指定tokenID对应的hap包申请的权限状态集合 | +| int GetPermissionFlag(AccessTokenID tokenID, const std::string& permissionName); | 查询指定tokenID的应用的指定权限 | +| int GrantPermission(AccessTokenID tokenID, const std::string& permissionName, int flag); | 授予指定tokenID的应用的指定权限 | +| int RevokePermission(AccessTokenID tokenID, const std::string& permissionName, int flag); | 撤销指定tokenID的应用的指定权限 | +| int ClearUserGrantedPermissionState(AccessTokenID tokenID); | 清空指定tokenID的应用的user_grant权限状态 | ## 相关仓 安全子系统 + [startup\_init\_lite](https://gitee.com/openharmony/startup_init_lite/blob/master/README.md) + [security\_deviceauth](https://gitee.com/openharmony/security_deviceauth/blob/master/README.md) + **[security\_access\_token](https://gitee.com/openharmony-sig/security_access_token/blob/master/README.md)** \ No newline at end of file -- Gitee