首页 > 其他分享 >eg

eg

时间:2024-07-31 11:39:19浏览次数:4  
标签:eg since SystemCapability BusinessError Security syscap throws

/*

  • Copyright (c) 2022-2023 Huawei Device Co., Ltd.
  • 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.
    */

/**

  • @file
  • @kit UniversalKeystoreKit
    */

import type { AsyncCallback } from './@ohos.base';

/**

  • OpenHarmony Universal KeyStore
  • @namespace huks
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • OpenHarmony Universal KeyStore
  • @namespace huks
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    declare namespace huks {
    /
    *
    • Generate Key.
    • @param { string } keyAlias - keyAlias indicates the key's name.
    • @param { HuksOptions } options - options indicates the properties of the key.
    • @param { AsyncCallback } callback - the callback of generateKey.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
    • @useinstead ohos.security.huks.generateKeyItem
      */
      function generateKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Generate Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.generateKeyItem
    */
    function generateKey(keyAlias: string, options: HuksOptions): Promise;

/**

  • Generate Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of generateKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Generate Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of generateKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    */
    function generateKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Generate Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Generate Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function generateKeyItem(keyAlias: string, options: HuksOptions): Promise;

/**

  • Generate Key As User.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function generateKeyItemAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Delete Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of deleteKey.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.deleteKeyItem
    */
    function deleteKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Delete Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.deleteKeyItem
    */
    function deleteKey(keyAlias: string, options: HuksOptions): Promise;

/**

  • Delete Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of deleteKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Delete Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of deleteKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    */
    function deleteKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Delete Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Delete Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function deleteKeyItem(keyAlias: string, options: HuksOptions): Promise;

/**

  • Delete Key As User.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function deleteKeyItemAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Import Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of importKey.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.importKeyItem
    */
    function importKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Import Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.importKeyItem
    */
    function importKey(keyAlias: string, options: HuksOptions): Promise;

/**

  • Import Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of importKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Import Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of importKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function importKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Import Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Import Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function importKeyItem(keyAlias: string, options: HuksOptions): Promise;

/**

  • Import Key As User.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function importKeyItemAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Import Wrapped Key.
  • @param { string } keyAlias - keyAlias indicates the name of key to be imported.
  • @param { string } wrappingKeyAlias - wrappingKeyAlias indicates the name of key for wrapping the key to be imported.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of importWrappedKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Import Wrapped Key.
  • @param { string } keyAlias - keyAlias indicates the name of key to be imported.
  • @param { string } wrappingKeyAlias - wrappingKeyAlias indicates the name of key for wrapping the key to be imported.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of importWrappedKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function importWrappedKeyItem(
    keyAlias: string,
    wrappingKeyAlias: string,
    options: HuksOptions,
    callback: AsyncCallback
    ): void;

/**

  • Import Wrapped Key As User.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the name of key to be imported.
  • @param { string } wrappingKeyAlias - wrappingKeyAlias indicates the name of key for wrapping the key to be imported.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function importWrappedKeyItemAsUser(userId: number, keyAlias: string, wrappingKeyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Import Wrapped Key.
  • @param { string } keyAlias - keyAlias indicates the name of key to be imported.
  • @param { string } wrappingKeyAlias - wrappingKeyAlias indicates the name of key for wrapping the key to be imported.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Import Wrapped Key.
  • @param { string } keyAlias - keyAlias indicates the name of key to be imported.
  • @param { string } wrappingKeyAlias - wrappingKeyAlias indicates the name of key for wrapping the key to be imported.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000013 - queried credential does not exist
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @throws { BusinessError } 12000015 - call service failed
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function importWrappedKeyItem(keyAlias: string, wrappingKeyAlias: string, options: HuksOptions): Promise;

/**

  • Export Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of exportKey.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.exportKeyItem
    */
    function exportKey(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Export Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.exportKeyItem
    */
    function exportKey(keyAlias: string, options: HuksOptions): Promise;

/**

  • Export Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of exportKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Export Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of exportKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function exportKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Export Key As User.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function exportKeyItemAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Export Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Export Key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function exportKeyItem(keyAlias: string, options: HuksOptions): Promise;

/**

  • Get properties of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of getKeyProperties.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.getKeyItemProperties
    */
    function getKeyProperties(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Get properties of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.getKeyItemProperties
    */
    function getKeyProperties(keyAlias: string, options: HuksOptions): Promise;

/**

  • Get properties of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of getKeyItemProperties.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Get properties of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of getKeyItemProperties.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function getKeyItemProperties(
    keyAlias: string,
    options: HuksOptions,
    callback: AsyncCallback
    ): void;

/**

  • Get properties of the key as user.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function getKeyItemPropertiesAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Get properties of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Get properties of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function getKeyItemProperties(keyAlias: string, options: HuksOptions): Promise;

/**

  • Check whether the key exists.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of isKeyExist.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.isKeyItemExist
    */
    function isKeyExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Check whether the key exists.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.isKeyItemExist
    */
    function isKeyExist(keyAlias: string, options: HuksOptions): Promise;

/**

  • Check whether the key exists.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of isKeyItemExist.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    */
    function isKeyItemExist(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Check whether the key exists.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    */
    function isKeyItemExist(keyAlias: string, options: HuksOptions): Promise;

/**

  • Check whether the key exists.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of isKeyItemExist.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    */
    function hasKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Check whether the key exists as user.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function hasKeyItemAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Check whether the key exists.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function hasKeyItem(keyAlias: string, options: HuksOptions): Promise;

/**

  • Init Operation.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of init, include the handle.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.initSession
    */
    function init(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Init Operation.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function, include the handle.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.initSession
    */
    function init(keyAlias: string, options: HuksOptions): Promise;

/**

  • Init Operation.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of initSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000010 - the number of sessions has reached limit
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Init Operation.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @param { AsyncCallback } callback - the callback of initSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000010 - the number of sessions has reached limit
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    */
    function initSession(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Init Operation.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000010 - the number of sessions has reached limit
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Init Operation.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000010 - the number of sessions has reached limit
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function initSession(keyAlias: string, options: HuksOptions): Promise;

/**

  • Init Operation As User.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000010 - the number of sessions has reached limit
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function initSessionAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Update Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { Uint8Array } token - token indicates the value of token.
  • @param { HuksOptions } options - options indicates the properties of the update operation.
  • @param { AsyncCallback } callback - the callback of update.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.updateSession
    */
    function update(handle: number, token?: Uint8Array, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Update Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { Uint8Array } token - indicates the value of token.
  • @param { HuksOptions } options - options indicates the properties of the update operation.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.updateSession
    */
    function update(handle: number, token?: Uint8Array, options: HuksOptions): Promise;

/**

  • Update Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the update operation.
  • @param { AsyncCallback } callback - the callback of updateSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Update Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the update operation.
  • @param { AsyncCallback } callback - the callback of updateSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    */
    function updateSession(handle: number, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Update Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the update operation.
  • @param { Uint8Array } token - token indicates the value of auth token from USER IAM service.
  • @param { AsyncCallback } callback - the callback of updateSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Update Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the update operation.
  • @param { Uint8Array } token - token indicates the value of auth token from USER IAM service.
  • @param { AsyncCallback } callback - the callback of updateSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function updateSession(
    handle: number,
    options: HuksOptions,
    token: Uint8Array,
    callback: AsyncCallback
    ): void;

/**

  • Update Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the update operation.
  • @param { Uint8Array } token - token indicates the value of auth token from USER IAM service.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Update Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the update operation.
  • @param { Uint8Array } token - token indicates the value of auth token from USER IAM service.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function updateSession(handle: number, options: HuksOptions, token?: Uint8Array): Promise;

/**

  • Finish Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the finish operation.
  • @param { AsyncCallback } callback - the callback of finish.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.finishSession
    */
    function finish(handle: number, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Finish Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the finish operation.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.finishSession
    */
    function finish(handle: number, options: HuksOptions): Promise;

/**

  • Finish Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the finish operation.
  • @param { AsyncCallback } callback - the callback of finishSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Finish Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the finish operation.
  • @param { AsyncCallback } callback - the callback of finishSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    */
    function finishSession(handle: number, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Finish Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the finish operation.
  • @param { Uint8Array } token - token indicates the value of auth token from USER IAM service.
  • @param { AsyncCallback } callback - the callback of finishSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Finish Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the finish operation.
  • @param { Uint8Array } token - token indicates the value of auth token from USER IAM service.
  • @param { AsyncCallback } callback - the callback of finishSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function finishSession(
    handle: number,
    options: HuksOptions,
    token: Uint8Array,
    callback: AsyncCallback
    ): void;

/**

  • Finish Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the finish operation.
  • @param { Uint8Array } token - token indicates the value of auth token from USER IAM service.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Finish Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the finish operation.
  • @param { Uint8Array } token - token indicates the value of auth token from USER IAM service.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000007 - this credential is already invalidated permanently
  • @throws { BusinessError } 12000008 - verify auth token failed
  • @throws { BusinessError } 12000009 - auth token is already timeout
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function finishSession(handle: number, options: HuksOptions, token?: Uint8Array): Promise;

/**

  • Abort Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the abort operation.
  • @param { AsyncCallback } callback - the callback of finishSession.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.abortSession
    */
    function abort(handle: number, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Abort Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the abort operation.
  • @returns { Promise } the promise returned by the function.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.abortSession
    */
    function abort(handle: number, options: HuksOptions): Promise;

/**

  • Abort Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the abort operation.
  • @param { AsyncCallback } callback - the callback of abortSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Abort Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the abort operation.
  • @param { AsyncCallback } callback - the callback of abortSession.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    */
    function abortSession(handle: number, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Abort Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the abort operation.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Abort Operation.
  • @param { number } handle - indicates the handle of the init operation.
  • @param { HuksOptions } options - options indicates the properties of the abort operation.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 11
    */
    function abortSession(handle: number, options: HuksOptions): Promise;

/**

  • Key Attestation. This API can be called only by system applications.
  • @permission ohos.permission.ATTEST_KEY
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key attestation operation.
  • @param { AsyncCallback } callback - the callback of attestKeyItem.
  • @throws { BusinessError } 201 - check permission failed
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    */
    function attestKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Key Attestation As User.
  • @permission ohos.permission.ATTEST_KEY and ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key attestation operation.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.ATTEST_KEY or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function attestKeyItemAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Key Attestation. This API can be called only by system applications.
  • @permission ohos.permission.ATTEST_KEY
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key attestation operation.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - check permission failed
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    */
    function attestKeyItem(keyAlias: string, options: HuksOptions): Promise;

/**

  • Key Attestation with anonymous certificate.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key attestation operation.
  • @param { AsyncCallback } callback - the callback of attestKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 11
    /
    /
    *
  • Key Attestation with anonymous certificate.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key attestation operation.
  • @param { AsyncCallback } callback - the callback of attestKeyItem.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function anonAttestKeyItem(keyAlias: string, options: HuksOptions, callback: AsyncCallback): void;

/**

  • Key Attestation with anonymous certificate as user.
  • @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
  • @param { number } userId - userId indicates the userId of the owner of the key.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } huksOptions - huksOptions indicates the properties of the key attestation operation.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 201 - Permission denied. An attempt was made to use key as user forbidden by permission: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS.
  • @throws { BusinessError } 202 - not system app
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @systemapi this method can be used only by system applications.
  • @since 12
    */
    function anonAttestKeyItemAsUser(userId: number, keyAlias: string, huksOptions: HuksOptions): Promise;

/**

  • Key Attestation with anonymous certificate.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key attestation operation.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 11
    /
    /
    *
  • Key Attestation with anonymous certificate.
  • @param { string } keyAlias - keyAlias indicates the key's name.
  • @param { HuksOptions } options - options indicates the properties of the key attestation operation.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 801 - api is not supported
  • @throws { BusinessError } 12000001 - algorithm mode is not supported
  • @throws { BusinessError } 12000002 - algorithm param is missing
  • @throws { BusinessError } 12000003 - algorithm param is invalid
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000006 - error occurred in crypto engine
  • @throws { BusinessError } 12000011 - queried entity does not exist
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function anonAttestKeyItem(keyAlias: string, options: HuksOptions): Promise;

/**

  • Get the sdk version.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { string } the character string of the sdk version.
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 11
    */
    function getSdkVersion(options: HuksOptions): string;

/**

  • list the key aliases.
  • @param { HuksOptions } options - options indicates the properties of the key.
  • @returns { Promise } the promise returned by the function.
  • @throws { BusinessError } 401 - Parameter error. Possible causes:
  •                             1. Mandatory parameters are left unspecified.
    
  •                             2. Incorrect parameter types.
    
  •                             3. Parameter verification failed.
    
  • @throws { BusinessError } 12000004 - operating file failed
  • @throws { BusinessError } 12000005 - IPC communication failed
  • @throws { BusinessError } 12000012 - external error
  • @throws { BusinessError } 12000014 - memory is insufficient
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    function listAliases(options: HuksOptions): Promise;

/**

  • Interface of huks param.
  • @typedef HuksParam
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Interface of huks param.
  • @typedef HuksParam
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export interface HuksParam {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      tag: HuksTag;
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      */
      value: boolean | number | bigint | Uint8Array;
      }

/**

  • Interface of huks handle.
  • @typedef HuksHandle
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.HuksSessionHandle
    /
    export interface HuksHandle {
    /
    *
    • @type
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      errorCode: number;
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      handle: number;
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      */
      token?: Uint8Array;
      }

/**

  • Interface of huks handle.
  • @typedef HuksSessionHandle
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Interface of huks handle.
  • @typedef HuksSessionHandle
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export interface HuksSessionHandle {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      handle: number;
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      */
      challenge?: Uint8Array;
      }

/**

  • Interface of huks option.
  • @typedef HuksOptions
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Interface of huks option.
  • @typedef HuksOptions
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export interface HuksOptions {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @type { ?Array }
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      properties?: Array;
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      */
      inData?: Uint8Array;
      }

/**

  • Interface of huks result.
  • @typedef HuksResult
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.HuksReturnResult
    /
    export interface HuksResult {
    /
    *
    • @type
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      errorCode: number;
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      outData?: Uint8Array;
      /
      *
    • @type { ?Array }
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      properties?: Array;
      /
      *
    • @type { ?Array }
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      */
      certChains?: Array;
      }

/**

  • Interface of huks result.
  • @typedef HuksReturnResult
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Interface of huks result.
  • @typedef HuksReturnResult
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export interface HuksReturnResult {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @type
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      outData?: Uint8Array;
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @type { ?Array }
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      properties?: Array;
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @type { ?Array }
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      */
      certChains?: Array;
      }
/**
  • Interface of huks ListAliases result.
  • @typedef HuksListAliasesReturnResult
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    */
    export interface HuksListAliasesReturnResult {
/**
 * the returned list of key aliases
 *
 * @type { Array<string> }
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
keyAliases: Array<string>;

}

/**

  • Enum for huks error code.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
  • @deprecated since 9
  • @useinstead ohos.security.huks.HuksExceptionErrCode
    /
    export enum HuksErrorCode {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_SUCCESS = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_FAILURE = -1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_BAD_STATE = -2,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_ARGUMENT = -3,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_NOT_SUPPORTED = -4,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_NO_PERMISSION = -5,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INSUFFICIENT_DATA = -6,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_BUFFER_TOO_SMALL = -7,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INSUFFICIENT_MEMORY = -8,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_COMMUNICATION_FAILURE = -9,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_STORAGE_FAILURE = -10,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_HARDWARE_FAILURE = -11,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_ALREADY_EXISTS = -12,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_NOT_EXIST = -13,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_NULL_POINTER = -14,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_FILE_SIZE_FAIL = -15,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_READ_FILE_FAIL = -16,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_PUBLIC_KEY = -17,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_PRIVATE_KEY = -18,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_KEY_INFO = -19,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_HASH_NOT_EQUAL = -20,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_MALLOC_FAIL = -21,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_WRITE_FILE_FAIL = -22,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_REMOVE_FILE_FAIL = -23,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_OPEN_FILE_FAIL = -24,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CLOSE_FILE_FAIL = -25,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_MAKE_DIR_FAIL = -26,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_KEY_FILE = -27,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_IPC_MSG_FAIL = -28,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_REQUEST_OVERFLOWS = -29,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_PARAM_NOT_EXIST = -30,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CRYPTO_ENGINE_ERROR = -31,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_COMMUNICATION_TIMEOUT = -32,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_IPC_INIT_FAIL = -33,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_IPC_DLOPEN_FAIL = -34,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_EFUSE_READ_FAIL = -35,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_NEW_ROOT_KEY_MATERIAL_EXIST = -36,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_UPDATE_ROOT_KEY_MATERIAL_FAIL = -37,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_VERIFICATION_FAILED = -38,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_ALG_FAIL = -100,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_KEY_SIZE_FAIL = -101,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_PADDING_FAIL = -102,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_PURPOSE_FAIL = -103,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_DIGEST_FAIL = -104,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_MODE_FAIL = -105,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_NONCE_FAIL = -106,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_AAD_FAIL = -107,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_IV_FAIL = -108,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_AE_TAG_FAIL = -109,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_SALT_FAIL = -110,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_CHECK_GET_ITERATION_FAIL = -111,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_ALGORITHM = -112,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_KEY_SIZE = -113,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_PADDING = -114,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_PURPOSE = -115,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_MODE = -116,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_DIGEST = -117,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_SIGNATURE_SIZE = -118,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_IV = -119,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_AAD = -120,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_NONCE = -121,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_AE_TAG = -122,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_SALT = -123,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_ITERATION = -124,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INVALID_OPERATION = -125,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      /
      HUKS_ERROR_INTERNAL_ERROR = -999,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
    • @deprecated since 9
      */
      HUKS_ERROR_UNKNOWN_ERROR = -1000
      }

/**

  • Enum for huks exception error code.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 9
    /
    /
    *
  • Enum for huks exception error code.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export enum HuksExceptionErrCode {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_PERMISSION_FAIL = 201,
      /
      *
    • Non-system applications are not allowed to use system APIs.
    • @syscap SystemCapability.Security.Huks.Core
    • @since 12
      /
      HUKS_ERR_CODE_NOT_SYSTEM_APP = 202,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_ILLEGAL_ARGUMENT = 401,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_NOT_SUPPORTED_API = 801,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_FEATURE_NOT_SUPPORTED = 12000001,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_MISSING_CRYPTO_ALG_ARGUMENT = 12000002,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_INVALID_CRYPTO_ALG_ARGUMENT = 12000003,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_FILE_OPERATION_FAIL = 12000004,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_COMMUNICATION_FAIL = 12000005,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_CRYPTO_FAIL = 12000006,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_KEY_AUTH_PERMANENTLY_INVALIDATED = 12000007,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_KEY_AUTH_VERIFY_FAILED = 12000008,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_KEY_AUTH_TIME_OUT = 12000009,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_SESSION_LIMIT = 12000010,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_ITEM_NOT_EXIST = 12000011,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_EXTERNAL_ERROR = 12000012,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_CREDENTIAL_NOT_EXIST = 12000013,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_INSUFFICIENT_MEMORY = 12000014,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_ERR_CODE_CALL_SERVICE_FAILED = 12000015,
      /
      *
    • A device password is required but not set.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 11
      /
      /
      *
    • A device password is required but not set.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_ERR_CODE_DEVICE_PASSWORD_UNSET = 12000016
      }

/**

  • Enum for huks key purpose.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks key purpose.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export enum HuksKeyPurpose {
    /
    *
    • Usable with RSA, EC and AES keys.
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • Usable with RSA, EC and AES keys.
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_KEY_PURPOSE_ENCRYPT = 1,
      /
      *
    • Usable with RSA, EC and AES keys.
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • Usable with RSA, EC and AES keys.
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_KEY_PURPOSE_DECRYPT = 2,
      /
      *
    • Usable with RSA, EC keys.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • Usable with RSA, EC keys.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_PURPOSE_SIGN = 4,
      /
      *
    • Usable with RSA, EC keys.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • Usable with RSA, EC keys.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_PURPOSE_VERIFY = 8,
      /
      *
    • Usable with EC keys.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • Usable with EC keys.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_PURPOSE_DERIVE = 16,
      /
      *
    • Usable with wrap key.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • Usable with wrap key.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_PURPOSE_WRAP = 32,
      /
      *
    • Usable with unwrap key.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • Usable with unwrap key.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_PURPOSE_UNWRAP = 64,
      /
      *
    • Usable with mac.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • Usable with mac.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_PURPOSE_MAC = 128,
      /
      *
    • Usable with agree.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • Usable with agree.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_KEY_PURPOSE_AGREE = 256
      }

/**

  • Enum for huks key digest.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
    /
    /
    *
  • Enum for huks key digest.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksKeyDigest {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_DIGEST_NONE = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_DIGEST_MD5 = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_DIGEST_SM3 = 2,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_DIGEST_SHA1 = 10,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_DIGEST_SHA224 = 11,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_DIGEST_SHA256 = 12,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_DIGEST_SHA384 = 13,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_DIGEST_SHA512 = 14
      }

/**

  • Enum for huks key padding.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks key padding.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export enum HuksKeyPadding {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_PADDING_NONE = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_PADDING_OAEP = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_PADDING_PSS = 2,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_PADDING_PKCS1_V1_5 = 3,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_PADDING_PKCS5 = 4,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      */
      HUKS_PADDING_PKCS7 = 5
      }

/**

  • Enum for huks cipher mode.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks cipher mode.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export enum HuksCipherMode {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      /
      HUKS_MODE_ECB = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      /
      HUKS_MODE_CBC = 2,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      /
      HUKS_MODE_CTR = 3,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_MODE_OFB = 4,
      /
      *
    • Cipher Feedback (CFB) mode
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_MODE_CFB = 5,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_MODE_CCM = 31,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_MODE_GCM = 32

}

/**

  • Enum for huks key size.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks key size.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export enum HuksKeySize {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_RSA_KEY_SIZE_512 = 512,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_RSA_KEY_SIZE_768 = 768,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_RSA_KEY_SIZE_1024 = 1024,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_RSA_KEY_SIZE_2048 = 2048,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_RSA_KEY_SIZE_3072 = 3072,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_RSA_KEY_SIZE_4096 = 4096,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ECC_KEY_SIZE_224 = 224,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ECC_KEY_SIZE_256 = 256,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ECC_KEY_SIZE_384 = 384,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ECC_KEY_SIZE_521 = 521,

/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_AES_KEY_SIZE_128 = 128,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_AES_KEY_SIZE_192 = 192,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_AES_KEY_SIZE_256 = 256,

/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 11
 */
HUKS_AES_KEY_SIZE_512 = 512,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_CURVE25519_KEY_SIZE_256 = 256,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_DH_KEY_SIZE_2048 = 2048,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_DH_KEY_SIZE_3072 = 3072,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_DH_KEY_SIZE_4096 = 4096,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_SM2_KEY_SIZE_256 = 256,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_SM4_KEY_SIZE_128 = 128

}

/**

  • Enum for huks key algorithm.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks key algorithm.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export enum HuksKeyAlg {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_ALG_RSA = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_ALG_ECC = 2,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_ALG_DSA = 3,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_ALG_AES = 20,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_HMAC = 50,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_HKDF = 51,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_PBKDF2 = 52,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_ECDH = 100,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_X25519 = 101,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_ED25519 = 102,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_DH = 103,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_SM2 = 150,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_SM3 = 151,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_ALG_SM4 = 152

}

/**

  • Enum for huks unwrap suite.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Enum for huks unwrap suite.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksUnwrapSuite {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_UNWRAP_SUITE_X25519_AES_256_GCM_NOPADDING = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_UNWRAP_SUITE_ECDH_AES_256_GCM_NOPADDING = 2
      }

/**

  • Enum for huks key generate type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
    /
    /
    *
  • Enum for huks key generate type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksKeyGenerateType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_GENERATE_TYPE_DEFAULT = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_GENERATE_TYPE_DERIVE = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_KEY_GENERATE_TYPE_AGREE = 2
      }

/**

  • Enum for huks key flag.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks key flag.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 12
    /
    export enum HuksKeyFlag {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_FLAG_IMPORT_KEY = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_FLAG_GENERATE_KEY = 2,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_FLAG_AGREE_KEY = 3,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 12
      */
      HUKS_KEY_FLAG_DERIVE_KEY = 4
      }

/**

  • Enum for huks key storage type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks key storage type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 12
    /
    export enum HuksKeyStorageType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
    • @deprecated since 10
      /
      HUKS_STORAGE_TEMP = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
    • @deprecated since 10
      /
      HUKS_STORAGE_PERSISTENT = 1,
      /
      *
    • The key is stored and used only in HUKS. It is mutually exclusive with HUKS_STORAGE_KEY_EXPORT_ALLOWED.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 10
      /
      /
      *
    • The key is stored and used only in HUKS. It is mutually exclusive with HUKS_STORAGE_KEY_EXPORT_ALLOWED.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_STORAGE_ONLY_USED_IN_HUKS = 2,
      /
      *
    • The key can be exported. It is mutually exclusive with HUKS_STORAGE_ONLY_USED_IN_HUKS.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 10
      /
      /
      *
    • The key can be exported. It is mutually exclusive with HUKS_STORAGE_ONLY_USED_IN_HUKS.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_STORAGE_KEY_EXPORT_ALLOWED = 3
      }

/**

  • Enum for huks import key type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Enum for huks import key type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksImportKeyType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_TYPE_PUBLIC_KEY = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_KEY_TYPE_PRIVATE_KEY = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_KEY_TYPE_KEY_PAIR = 2
      }

/**

  • Enum for rsa salt len type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 10
    /
    /
    *
  • Enum for rsa salt len type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksRsaPssSaltLenType {
    /
    *
    • Salt length that matches the digest length.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 10
      /
      /
      *
    • Salt length that matches the digest length.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_RSA_PSS_SALT_LEN_DIGEST = 0,
/**
 * Maximum salt length.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 10
 */
/**
 * Maximum salt length.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_RSA_PSS_SALT_LEN_MAX = 1

}

/**

  • Enum for huks user auth type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Enum for huks user auth type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksUserAuthType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_USER_AUTH_TYPE_FINGERPRINT = 1 << 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_USER_AUTH_TYPE_FACE = 1 << 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_USER_AUTH_TYPE_PIN = 1 << 2
      }

/**

  • Enum for huks auth access type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Enum for huks auth access type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksAuthAccessType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_AUTH_ACCESS_INVALID_CLEAR_PASSWORD = 1 << 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_AUTH_ACCESS_INVALID_NEW_BIO_ENROLL = 1 << 1,
      /
      *
    • Auth type for always valid.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 11
      /
      /
      *
    • Auth type for always valid.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_AUTH_ACCESS_ALWAYS_VALID = 1 << 2
      }

/**

  • Enum for huks user auth mode.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksUserAuthMode {
    /
    *
    • Auth mode for local scenarios.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_USER_AUTH_MODE_LOCAL = 0,
      /
      *
    • Auth mode for co-auth scenarios.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_USER_AUTH_MODE_COAUTH = 1,
      }
      /
      *
  • Enum for huks key file storage authentication level.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 11
    /
    /
    *
  • Enum for huks key file storage authentication level.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksAuthStorageLevel {
    /
    *
    • Key file storage security level for device encryption standard.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 11
      /
      /
      *
    • Key file storage security level for device encryption standard.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_AUTH_STORAGE_LEVEL_DE = 0,
      /
      *
    • Key file storage security level for credential encryption standard.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 11
      /
      /
      *
    • Key file storage security level for credential encryption standard.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_AUTH_STORAGE_LEVEL_CE = 1,
      /
      *
    • Key file storage security level for enhanced credential encryption standard.
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 11
      /
      /
      *
    • Key file storage security level for enhanced credential encryption standard.
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_AUTH_STORAGE_LEVEL_ECE = 2,
      }

/**

  • Enum for huks auth access challenge type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Enum for huks auth access challenge type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksChallengeType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_CHALLENGE_TYPE_NORMAL = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_CHALLENGE_TYPE_CUSTOM = 1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_CHALLENGE_TYPE_NONE = 2
      }

/**

  • Enum for huks challenge position.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Enum for huks challenge position.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksChallengePosition {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_CHALLENGE_POS_0 = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_CHALLENGE_POS_1,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_CHALLENGE_POS_2,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_CHALLENGE_POS_3
      }

/**

  • Enum for huks secure sign type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 9
    /
    /
    *
  • Enum for huks secure sign type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksSecureSignType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 9
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_SECURE_SIGN_WITH_AUTHINFO = 1
      }

/**

  • Enum for huks ipc send type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @since 8
    /
    /
    *
  • Enum for huks ipc send type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Extension
  • @atomicservice
  • @since 12
    /
    export enum HuksSendType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      /
      HUKS_SEND_TYPE_ASYNC = 0,
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Extension
    • @atomicservice
    • @since 12
      */
      HUKS_SEND_TYPE_SYNC = 1
      }

/**

  • Enum for huks base tag type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks base tag type.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export enum HuksTagType {
    /
    *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_TAG_TYPE_INVALID = 0 << 28,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_TAG_TYPE_INT = 1 << 28,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_TAG_TYPE_UINT = 2 << 28,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_TAG_TYPE_ULONG = 3 << 28,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      /
      HUKS_TAG_TYPE_BOOL = 4 << 28,
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
      /
      /
      *
    • @syscap SystemCapability.Security.Huks.Core
    • @atomicservice
    • @since 11
      */
      HUKS_TAG_TYPE_BYTES = 5 << 28
      }

/**

  • Enum for huks tag.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @since 8
    /
    /
    *
  • Enum for huks tag.
  • @enum
  • @syscap SystemCapability.Security.Huks.Core
  • @atomicservice
  • @since 11
    /
    export enum HuksTag {
    /
    *
    • Invalid TAG
    • @syscap SystemCapability.Security.Huks.Core
    • @since 8
    • @deprecated since 9
      */
      HUKS_TAG_INVALID = HuksTagType.HUKS_TAG_TYPE_INVALID | 0,
/* Base algorithm TAG: 1 - 200 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_ALGORITHM = HuksTagType.HUKS_TAG_TYPE_UINT | 1,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_PURPOSE = HuksTagType.HUKS_TAG_TYPE_UINT | 2,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_KEY_SIZE = HuksTagType.HUKS_TAG_TYPE_UINT | 3,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_DIGEST = HuksTagType.HUKS_TAG_TYPE_UINT | 4,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_PADDING = HuksTagType.HUKS_TAG_TYPE_UINT | 5,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_BLOCK_MODE = HuksTagType.HUKS_TAG_TYPE_UINT | 6,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 7,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_ASSOCIATED_DATA = HuksTagType.HUKS_TAG_TYPE_BYTES | 8,

/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_NONCE = HuksTagType.HUKS_TAG_TYPE_BYTES | 9,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_IV = HuksTagType.HUKS_TAG_TYPE_BYTES | 10,

/**
 * Key derivation TAG.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * Key derivation TAG.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_INFO = HuksTagType.HUKS_TAG_TYPE_BYTES | 11,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_SALT = HuksTagType.HUKS_TAG_TYPE_BYTES | 12,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_PWD = HuksTagType.HUKS_TAG_TYPE_BYTES | 13,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ITERATION = HuksTagType.HUKS_TAG_TYPE_UINT | 14,

/**
 * choose from enum HuksKeyGenerateType.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * choose from enum HuksKeyGenerateType.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_GENERATE_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 15,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_DERIVE_MAIN_KEY = HuksTagType.HUKS_TAG_TYPE_BYTES | 16,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_DERIVE_FACTOR = HuksTagType.HUKS_TAG_TYPE_BYTES | 17,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_DERIVE_ALG = HuksTagType.HUKS_TAG_TYPE_UINT | 18,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_AGREE_ALG = HuksTagType.HUKS_TAG_TYPE_UINT | 19,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_AGREE_PUBLIC_KEY_IS_KEY_ALIAS = HuksTagType.HUKS_TAG_TYPE_BOOL | 20,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_AGREE_PRIVATE_KEY_ALIAS = HuksTagType.HUKS_TAG_TYPE_BYTES | 21,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_AGREE_PUBLIC_KEY = HuksTagType.HUKS_TAG_TYPE_BYTES | 22,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_KEY_ALIAS = HuksTagType.HUKS_TAG_TYPE_BYTES | 23,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_DERIVE_KEY_SIZE = HuksTagType.HUKS_TAG_TYPE_UINT | 24,

/**
 * Choose from enum HuksImportKeyType
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * Choose from enum HuksImportKeyType
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_IMPORT_KEY_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 25,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_UNWRAP_ALGORITHM_SUITE = HuksTagType.HUKS_TAG_TYPE_UINT | 26,

/**
 * Key storage type, which can be HUKS_STORAGE_ONLY_USED_IN_HUKS or HUKS_STORAGE_KEY_EXPORT_ALLOWED.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 10
 */
/**
 * Key storage type, which can be HUKS_STORAGE_ONLY_USED_IN_HUKS or HUKS_STORAGE_KEY_EXPORT_ALLOWED.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_DERIVED_AGREED_KEY_STORAGE_FLAG = HuksTagType.HUKS_TAG_TYPE_UINT | 29,

/**
 * RSA salt length type. For details, see HuksRsaPssSaltLenType.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 10
 */
/**
 * RSA salt length type. For details, see HuksRsaPssSaltLenType.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_RSA_PSS_SALT_LEN_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 30,

/*
 * Key authentication related TAG: 201 - 300
 *
 * Start of validity
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ACTIVE_DATETIME = HuksTagType.HUKS_TAG_TYPE_ULONG | 201,
/**
 * Date when new "messages" should not be created.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ORIGINATION_EXPIRE_DATETIME = HuksTagType.HUKS_TAG_TYPE_ULONG | 202,
/**
 * Date when existing "messages" should not be used.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_USAGE_EXPIRE_DATETIME = HuksTagType.HUKS_TAG_TYPE_ULONG | 203,
/**
 * Key creation time.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_CREATION_DATETIME = HuksTagType.HUKS_TAG_TYPE_ULONG | 204,

/* Other authentication related TAG: 301 - 500 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ALL_USERS = HuksTagType.HUKS_TAG_TYPE_BOOL | 301,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_USER_ID = HuksTagType.HUKS_TAG_TYPE_UINT | 302,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_NO_AUTH_REQUIRED = HuksTagType.HUKS_TAG_TYPE_BOOL | 303,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_USER_AUTH_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 304,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_AUTH_TIMEOUT = HuksTagType.HUKS_TAG_TYPE_UINT | 305,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_AUTH_TOKEN = HuksTagType.HUKS_TAG_TYPE_BYTES | 306,

/* Key secure access control and user auth TAG */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_AUTH_ACCESS_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 307,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_SECURE_SIGN_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 308,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_CHALLENGE_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 309,

/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 9
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_CHALLENGE_POS = HuksTagType.HUKS_TAG_TYPE_UINT | 310,

/**
 * Supported key secure access control purpose tag, the value from enum HuksKeyPurpose.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 10
 */
/**
 * Supported key secure access control purpose tag, the value from enum HuksKeyPurpose.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_AUTH_PURPOSE = HuksTagType.HUKS_TAG_TYPE_UINT | 311,

/**
 * Security level of access control for key file storage, whose optional values are from enum HuksAuthStorageLevel.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 11
 */
/**
 * Security level of access control for key file storage, whose optional values are from enum HuksAuthStorageLevel.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_AUTH_STORAGE_LEVEL = HuksTagType.HUKS_TAG_TYPE_UINT | 316,

/**
 * Authentication mode of the user authtoken, whose optional values are from enum HuksUserAuthMode.
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_USER_AUTH_MODE = HuksTagType.HUKS_TAG_TYPE_UINT | 319,

/* Attestation related TAG: 501 - 600 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ATTESTATION_CHALLENGE = HuksTagType.HUKS_TAG_TYPE_BYTES | 501,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ATTESTATION_APPLICATION_ID = HuksTagType.HUKS_TAG_TYPE_BYTES | 502,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_BRAND = HuksTagType.HUKS_TAG_TYPE_BYTES | 503,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_DEVICE = HuksTagType.HUKS_TAG_TYPE_BYTES | 504,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_PRODUCT = HuksTagType.HUKS_TAG_TYPE_BYTES | 505,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_SERIAL = HuksTagType.HUKS_TAG_TYPE_BYTES | 506,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_IMEI = HuksTagType.HUKS_TAG_TYPE_BYTES | 507,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_MEID = HuksTagType.HUKS_TAG_TYPE_BYTES | 508,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_MANUFACTURER = HuksTagType.HUKS_TAG_TYPE_BYTES | 509,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_MODEL = HuksTagType.HUKS_TAG_TYPE_BYTES | 510,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ATTESTATION_ID_ALIAS = HuksTagType.HUKS_TAG_TYPE_BYTES | 511,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_SOCID = HuksTagType.HUKS_TAG_TYPE_BYTES | 512,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ATTESTATION_ID_UDID = HuksTagType.HUKS_TAG_TYPE_BYTES | 513,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ATTESTATION_ID_SEC_LEVEL_INFO = HuksTagType.HUKS_TAG_TYPE_BYTES | 514,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ATTESTATION_ID_VERSION_INFO = HuksTagType.HUKS_TAG_TYPE_BYTES | 515,

/*
 * Other reserved TAG: 601 - 1000
 *
 * Extension TAG: 1001 - 9999
 */

/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_IS_KEY_ALIAS = HuksTagType.HUKS_TAG_TYPE_BOOL | 1001,
/**
 * choose from enum HuksKeyStorageType.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * choose from enum HuksKeyStorageType.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_STORAGE_FLAG = HuksTagType.HUKS_TAG_TYPE_UINT | 1002,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_IS_ALLOWED_WRAP = HuksTagType.HUKS_TAG_TYPE_BOOL | 1003,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_WRAP_TYPE = HuksTagType.HUKS_TAG_TYPE_UINT | 1004,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_AUTH_ID = HuksTagType.HUKS_TAG_TYPE_BYTES | 1005,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_ROLE = HuksTagType.HUKS_TAG_TYPE_UINT | 1006,
/**
 * choose from enum HuksKeyFlag.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * choose from enum HuksKeyFlag.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_FLAG = HuksTagType.HUKS_TAG_TYPE_UINT | 1007,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_IS_ASYNCHRONIZED = HuksTagType.HUKS_TAG_TYPE_UINT | 1008,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_SECURE_KEY_ALIAS = HuksTagType.HUKS_TAG_TYPE_BOOL | 1009,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_SECURE_KEY_UUID = HuksTagType.HUKS_TAG_TYPE_BYTES | 1010,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY_DOMAIN = HuksTagType.HUKS_TAG_TYPE_UINT | 1011,

/**
 * Key access control based on device password setting status. True means the key can only be generated and used when the password is set.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 11
 */
/**
 * Key access control based on device password setting status. True means the key can only be generated and used when the password is set.
 *
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_IS_DEVICE_PASSWORD_SET = HuksTagType.HUKS_TAG_TYPE_BOOL | 1012,

/* Inner-use TAG: 10001 - 10999 */

/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_PROCESS_NAME = HuksTagType.HUKS_TAG_TYPE_BYTES | 10001,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_PACKAGE_NAME = HuksTagType.HUKS_TAG_TYPE_BYTES | 10002,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_ACCESS_TIME = HuksTagType.HUKS_TAG_TYPE_UINT | 10003,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_USES_TIME = HuksTagType.HUKS_TAG_TYPE_UINT | 10004,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_CRYPTO_CTX = HuksTagType.HUKS_TAG_TYPE_ULONG | 10005,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_KEY = HuksTagType.HUKS_TAG_TYPE_BYTES | 10006,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_KEY_VERSION = HuksTagType.HUKS_TAG_TYPE_UINT | 10007,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_PAYLOAD_LEN = HuksTagType.HUKS_TAG_TYPE_UINT | 10008,

/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 11
 */
HUKS_TAG_AE_TAG = HuksTagType.HUKS_TAG_TYPE_BYTES | 10009,

/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_IS_KEY_HANDLE = HuksTagType.HUKS_TAG_TYPE_ULONG | 10010,

/**
 * Os version related TAG.
 *
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_OS_VERSION = HuksTagType.HUKS_TAG_TYPE_UINT | 10101,
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 * @deprecated since 9
 */
HUKS_TAG_OS_PATCHLEVEL = HuksTagType.HUKS_TAG_TYPE_UINT | 10102,

/*
 * Reserved TAGs: 11000 - 12000
 *
 * Other TAGs: 20001 - N
 * TAGs used for paramSetOut
 */

/**
 * @syscap SystemCapability.Security.Huks.Core
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Core
 * @atomicservice
 * @since 12
 */
HUKS_TAG_SYMMETRIC_KEY_DATA = HuksTagType.HUKS_TAG_TYPE_BYTES | 20001,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ASYMMETRIC_PUBLIC_KEY_DATA = HuksTagType.HUKS_TAG_TYPE_BYTES | 20002,
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @since 8
 */
/**
 * @syscap SystemCapability.Security.Huks.Extension
 * @atomicservice
 * @since 12
 */
HUKS_TAG_ASYMMETRIC_PRIVATE_KEY_DATA = HuksTagType.HUKS_TAG_TYPE_BYTES | 20003

}
}

export default huks;

标签:eg,since,SystemCapability,BusinessError,Security,syscap,throws
From: https://www.cnblogs.com/zwkyd/p/18334295

相关文章

  • 在预定时间从 python telegram bot 发起对话
    对于没有提供代码,我提前表示歉意。我明天会尝试添加它,但我现在还没有接近它,思考如何解决这个问题让我一直在思考。我已经为一个机器人创建了一个程序,该程序的数据帧充满了之前请求的用户添加到机器人的消息列表中。现在,机器人使用job_queue在一天中的随机时间向每个用户发......
  • 什么是Ego Status?
    在自动驾驶领域,“EgoStatus”通常指的是自动驾驶车辆自身的状态信息。这个术语是从机器人学和自动化领域借用的,其中“Ego”代表主体或“自我”,即自动驾驶车辆自身。以下是“EgoStatus”可能包含的一些具体信息:位置(Position):车辆在地图上的具体坐标。速度(Velocity):车辆移动......
  • 一个基于 SourceGenerator 生成 从 dbReader转换为 class 数据的性能测试实验
    好奇SourceGenerator出现开始,好几年了,虽然一直好奇用SourceGenerator生成代码与emit等动态生成的代码会有多少差距,但是一直特别懒,不想搞其实dapperaot项目做了类似事情,不过功能特别积极,还引用了实验特性,所以还是想更为简单客观对比本次乘着自己暂时性不懒了,做了一个基......
  • 在 Windows 上使用 FFmpeg
    在Windows上使用FFmpeg进行各种多媒体操作相对直接,但需要先完成安装。下面是详细的步骤,包括如何安装和使用FFmpeg:1.安装FFmpeg下载FFmpeg:访问FFmpeg官方网站。在Windows部分,点击WindowsbuildsbyBtbN或WindowsbuildsbyZeranoe(如果有可用)。解压FFmpe......
  • KerasRegressor 决定系数 R^2 分数
    我正在Keras中构建一个用于回归任务的小型神经网络,我想使用与scikit-learnRandomForestRegressor:系数R^2定义为|相同的精度指标|||,其中(1-u/v)是回归平方和u,而((y_true-y_pred)**2).sum()是残差平方和......
  • 在工作线程中找到基于 Celery 类的任务,但在使用时得到 NotRegistered
    我像那样配置CeleryfromceleryimportCeleryfromsettings.configimportsettingscelery_app=Celery(broker=settings.RABBITMQ_URL,backend="rpc://",)celery_app.config_from_object(settings.CELERY_SETTINGS_MODULE)celery_app.autodiscov......
  • 编写用于关键字检测和按钮发送的 Python Telegram 机器人
    我需要帮助用Python为我的Telegram机器人编写代码。我有一个config.py文件,其中包含两个关键字列表:keywords和button_phrases。keywords-负责在单击时显示子按钮的按钮。Button_phrases-负责单击时打开链接的按钮。我需要机器人检查用户输入的文本并按以下顺......
  • Telegram 可以通过聊天功能分享吗?
    大家好,请精通telegramAPI的人。我正在尝试启动这种pfehare弹出窗口,它看起来像是我的快速API中的telegram原生的,但没有运气。你知道它应该如何工作吗?我一直在尝试一切,但我什至无法在电报文档中找到任何内容谢谢很遗憾,TelegramAPI没有提......
  • AtCoder Beginner Contest 362
    AtCoderBeginnerContest362前言vp的时候出了四题,被C题卡了一会,很久才出,D题是dijkstra的板子,改下条件即可,E题是个计数dp,这类题一直不怎么擅长,想起之前杭电第一场那个序列立方的题也是类似这种计数dp,需要加强练习。A-BuyaPen(atcoder.jp)思路判断两两最小。......
  • train_test_split 导致 xgboost 忽略“enable_categorical”
    我正在使用xgboost版本2.1.0当使用xgboost.DMatrix()和'enable_categorical'=True将包含类别列的pandas数据帧转换为DMatrix时,所有行为均按预期运行,除非数据帧是sklearntrain_test_split()返回的数据帧,尽管所有列的数据类型仍属于类别。以下代码产生预期的......