AESEncryptionHelper

All Implemented Interfaces:
```
public final class AESEncryptionHelper

                    
```
MIT License
Copyright (c) 2021 Raphael Ebner
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`AESEncryptionHelper.Companion`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`AESEncryptionHelper()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final ByteArray`	`readFile(File file)`	This method will convert a file to ByteArray
`final Unit`	`saveFile(ByteArray fileData, File file)`	This method will convert a ByteArray to a file, and saves it to the path
`final SecretKey`	`getSecretKey(SharedPreferences sharedPref, ByteArray iv)`	This method will convert a random password, saved in sharedPreferences to a SecretKey
`final SecretKey`	`getSecretKeyWithCustomPw(String encryptPassword, ByteArray iv)`	This method will convert a custom password to a SecretKey

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AESEncryptionHelper
```
AESEncryptionHelper()
```
- Method Detail
  - readFile
```
 final ByteArray readFile(File file)
```
    This method will convert a file to ByteArray
    
    Parameters:
    
    file - : the Path where the file is located
  - saveFile
```
 final Unit saveFile(ByteArray fileData, File file)
```
    This method will convert a ByteArray to a file, and saves it to the path
    
    Parameters:
    
    fileData - : the ByteArray
    
    file - : the path where the ByteArray should be saved
  - getSecretKey
```
 final SecretKey getSecretKey(SharedPreferences sharedPref, ByteArray iv)
```
    This method will convert a random password, saved in sharedPreferences to a SecretKey
    
    Parameters:
    
    sharedPref - : the sharedPref, to fetch / save the key
    
    iv - : the encryption nonce
  - getSecretKeyWithCustomPw
```
 final SecretKey getSecretKeyWithCustomPw(String encryptPassword, ByteArray iv)
```
    This method will convert a custom password to a SecretKey
    
    Parameters:
    
    encryptPassword - : the custom user password as String
    
    iv - : the encryption nonce