> For the complete documentation index, see [llms.txt](https://osl.mistium.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://osl.mistium.com/packages/crypto/crypto.md).

# crypto

> Hashing, HMAC, AES, password hashing, file encryption, random

Use `crypto` for hashing, random values, encoding helpers, password checks, signatures, and file encryption helpers.

```javascript
import "osl/crypto"
```

## Example

```javascript
import "osl/crypto"

string digest = crypto.sha256("hello")
string id = crypto.randomUUID()
log digest
```

## API reference

### `crypto`

| Method                                                                                 | Returns   | Description                               |
| -------------------------------------------------------------------------------------- | --------- | ----------------------------------------- |
| `crypto.sha1(data: any)`                                                               | `string`  | Runs the sha1 operation.                  |
| `crypto.sha256(data: any)`                                                             | `string`  | Runs the sha256 operation.                |
| `crypto.sha512(data: any)`                                                             | `string`  | Runs the sha512 operation.                |
| `crypto.md5(data: any)`                                                                | `string`  | Runs the md5 operation.                   |
| `crypto.sha3_256(data: any)`                                                           | `string`  | Runs the sha3 256 operation.              |
| `crypto.hmacSha256(key: any, data: any)`                                               | `string`  | Runs the hmac sha256 operation.           |
| `crypto.hmacSha512(key: any, data: any)`                                               | `string`  | Runs the hmac sha512 operation.           |
| `crypto.md5Hash(data: any)`                                                            | `string`  | Runs the md5 hash operation.              |
| `crypto.aes256Encrypt(key: any, plaintext: any)`                                       | `string`  | Runs the aes256 encrypt operation.        |
| `crypto.aes256Decrypt(key: any, ciphertext: any)`                                      | `string`  | Runs the aes256 decrypt operation.        |
| `crypto.randomBytes(size: any)`                                                        | `string`  | Generates random bytes.                   |
| `crypto.randomInt(...args: any)`                                                       | `number`  | Generates random int.                     |
| `crypto.randomString(length: any)`                                                     | `string`  | Generates random string.                  |
| `crypto.randomFloat(...args: any)`                                                     | `number`  | Generates random float.                   |
| `crypto.uuidv4()`                                                                      | `string`  | Runs the uuidv4 operation.                |
| `crypto.randomUUID()`                                                                  | `string`  | Generates random uuid.                    |
| `crypto.random(min: any, max: any)`                                                    | `any`     | Runs the random operation.                |
| `crypto.hash(hashFunc: any, data: any)`                                                | `string`  | Runs the hash operation.                  |
| `crypto.pbkdf2(password: any, salt: any, iterations: any, keyLen: any, hashFunc: any)` | `string`  | Runs the pbkdf2 operation.                |
| `crypto.hexEncode(data: any)`                                                          | `string`  | Runs the hex encode operation.            |
| `crypto.hexDecode(data: any)`                                                          | `string`  | Runs the hex decode operation.            |
| `crypto.binEncode(data: any)`                                                          | `string`  | Runs the bin encode operation.            |
| `crypto.binDecode(data: any)`                                                          | `string`  | Runs the bin decode operation.            |
| `crypto.base64Encode(data: any)`                                                       | `string`  | Runs the base64 encode operation.         |
| `crypto.base64Decode(data: any)`                                                       | `string`  | Runs the base64 decode operation.         |
| `crypto.hashPassword(password: any)`                                                   | `string`  | Runs the hash password operation.         |
| `crypto.verifyPassword(password: any, storedHash: any)`                                | `boolean` | Verifies password.                        |
| `crypto.generateKeyPair()`                                                             | `object`  | Runs the generate key pair operation.     |
| `crypto.sign(key: any, data: any)`                                                     | `string`  | Runs the sign operation.                  |
| `crypto.verify(key: any, data: any, signature: any)`                                   | `boolean` | Runs the verify operation.                |
| `crypto.constantTimeCompare(a: any, b: any)`                                           | `boolean` | Runs the constant time compare operation. |
| `crypto.encrypt(data: any, password: any)`                                             | `string`  | Runs the encrypt operation.               |
| `crypto.decrypt(data: any, password: any)`                                             | `string`  | Runs the decrypt operation.               |
| `crypto.encryptFile(inputPath: any, outputPath: any, password: any)`                   | `boolean` | Encrypts file.                            |
| `crypto.decryptFile(inputPath: any, outputPath: any, password: any)`                   | `boolean` | Decrypts file.                            |
| `crypto.hashFile(filePath: any)`                                                       | `string`  | Runs the hash file operation.             |
| `crypto.hashDirectory(dirPath: any)`                                                   | `string`  | Runs the hash directory operation.        |
| `crypto.secureErase(filePath: any)`                                                    | `boolean` | Runs the secure erase operation.          |

## Notes

* Standard-library imports accept both `import "osl/crypto"` and `import "crypto"`.
* Return values such as `array` and `object` are regular OSL values unless a returned object section says otherwise.