103 строки
5.5 KiB
YAML
103 строки
5.5 KiB
YAML
### YamlMime:JavaType
|
|
constructors:
|
|
- fullName: com.microsoft.aad.adal.StorageHelper.StorageHelper(Context context)
|
|
name: StorageHelper(Context context)
|
|
nameWithType: StorageHelper.StorageHelper(Context context)
|
|
parameters:
|
|
- description: <p>The <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Context"></xref> to create <xref uid="com.microsoft.aad.adal.StorageHelper" data-throw-if-not-resolved="false" data-raw-source="StorageHelper"></xref>. </p>
|
|
name: context
|
|
type: <xref href="Context?alt=Context&text=Context" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Constructor for <xref uid="com.microsoft.aad.adal.StorageHelper" data-throw-if-not-resolved="false" data-raw-source="StorageHelper"></xref>.</p>
|
|
|
|
<p></p>
|
|
syntax: public StorageHelper(Context context)
|
|
uid: com.microsoft.aad.adal.StorageHelper.StorageHelper(Context)
|
|
fields:
|
|
- field:
|
|
type: <xref href="final+int?alt=final+int&text=final+int" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.aad.adal.StorageHelper.DATA_KEY_LENGTH
|
|
name: DATA_KEY_LENGTH
|
|
nameWithType: StorageHelper.DATA_KEY_LENGTH
|
|
summary: <p>IV Key length for AES-128. </p>
|
|
syntax: public static final int DATA_KEY_LENGTH= 16
|
|
uid: com.microsoft.aad.adal.StorageHelper.DATA_KEY_LENGTH
|
|
- field:
|
|
type: <xref href="final+int?alt=final+int&text=final+int" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.aad.adal.StorageHelper.HMAC_LENGTH
|
|
name: HMAC_LENGTH
|
|
nameWithType: StorageHelper.HMAC_LENGTH
|
|
summary: <p>256 bits output for signing message. </p>
|
|
syntax: public static final int HMAC_LENGTH= 32
|
|
uid: com.microsoft.aad.adal.StorageHelper.HMAC_LENGTH
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.aad.adal.StorageHelper.VERSION_ANDROID_KEY_STORE
|
|
name: VERSION_ANDROID_KEY_STORE
|
|
nameWithType: StorageHelper.VERSION_ANDROID_KEY_STORE
|
|
summary: <p>Indicate that token item is encrypted with the key persisted in AndroidKeyStore. </p>
|
|
syntax: public static final String VERSION_ANDROID_KEY_STORE= "A001"
|
|
uid: com.microsoft.aad.adal.StorageHelper.VERSION_ANDROID_KEY_STORE
|
|
- field:
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
fullName: com.microsoft.aad.adal.StorageHelper.VERSION_USER_DEFINED
|
|
name: VERSION_USER_DEFINED
|
|
nameWithType: StorageHelper.VERSION_USER_DEFINED
|
|
summary: <p>Indicate that the token item is encrypted with the user provided key. </p>
|
|
syntax: public static final String VERSION_USER_DEFINED= "U001"
|
|
uid: com.microsoft.aad.adal.StorageHelper.VERSION_USER_DEFINED
|
|
inheritances:
|
|
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
|
methods:
|
|
- fullName: com.microsoft.aad.adal.StorageHelper.decrypt(final String encryptedBlob)
|
|
name: decrypt(final String encryptedBlob)
|
|
nameWithType: StorageHelper.decrypt(final String encryptedBlob)
|
|
parameters:
|
|
- description: <p>The blob to decrypt </p>
|
|
name: encryptedBlob
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
exceptions:
|
|
- type: <xref href="GeneralSecurityException?alt=GeneralSecurityException&text=GeneralSecurityException" data-throw-if-not-resolved="False"/>
|
|
description: <p>for key related exceptions. </p>
|
|
- type: <xref href="IOException?alt=IOException&text=IOException" data-throw-if-not-resolved="False"/>
|
|
description: <p>For general IO related exceptions. </p>
|
|
returns:
|
|
description: <p>Decrypted clear text. </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Decrypt encrypted blob with either user provided key or key persisted in AndroidKeyStore.</p>
|
|
|
|
<p></p>
|
|
syntax: public String decrypt(final String encryptedBlob)
|
|
uid: com.microsoft.aad.adal.StorageHelper.decrypt(final String)
|
|
- fullName: com.microsoft.aad.adal.StorageHelper.encrypt(final String clearText)
|
|
name: encrypt(final String clearText)
|
|
nameWithType: StorageHelper.encrypt(final String clearText)
|
|
parameters:
|
|
- description: <p>Clear text to encrypt. </p>
|
|
name: clearText
|
|
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
|
|
exceptions:
|
|
- type: <xref href="GeneralSecurityException?alt=GeneralSecurityException&text=GeneralSecurityException" data-throw-if-not-resolved="False"/>
|
|
description: <p>for key related exceptions. </p>
|
|
- type: <xref href="IOException?alt=IOException&text=IOException" data-throw-if-not-resolved="False"/>
|
|
description: <p>For general IO related exceptions. </p>
|
|
returns:
|
|
description: <p>Encrypted blob. </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Encrypt text with current key based on API level.</p>
|
|
|
|
<p></p>
|
|
syntax: public String encrypt(final String clearText)
|
|
uid: com.microsoft.aad.adal.StorageHelper.encrypt(final String)
|
|
nameWithType: StorageHelper
|
|
syntax: public class StorageHelper
|
|
type: class
|
|
uid: com.microsoft.aad.adal.StorageHelper
|
|
fullName: com.microsoft.aad.adal.StorageHelper
|
|
name: StorageHelper
|
|
package: com.microsoft.aad.adal
|
|
summary: "<p>Shared preferences store clear text. This class helps to encrypt/decrypt text to store. API SDK>= 18 has more security with AndroidKeyStore. Note: <xref uid=\"com.microsoft.aad.adal.StorageHelper\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageHelper\"></xref> is designed for the ADAL internal encryption/decryption. Don't take dependency on it for external use. </p>"
|
|
metadata: {}
|