https://github.com/lucacicada/xipher
xipher is a simple wrapper around the subtle crypto API.
https://github.com/lucacicada/xipher
hmac sha256 subtlecrypto
Last synced: 4 months ago
JSON representation
xipher is a simple wrapper around the subtle crypto API.
- Host: GitHub
- URL: https://github.com/lucacicada/xipher
- Owner: lucacicada
- License: mit
- Created: 2024-06-24T09:02:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T13:51:05.000Z (about 2 years ago)
- Last Synced: 2025-10-19T08:04:14.430Z (8 months ago)
- Topics: hmac, sha256, subtlecrypto
- Language: TypeScript
- Homepage:
- Size: 99.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# xipher
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![License][license-src]][license-href]
xipher is a simple wrapper around the subtle crypto API.
## Installation
```bash
pnpm add xipher
```
## Usage
### `pbkdf2(password, keyLength)`
Derive a key from a base password using pbkdf2.
```ts
import { pbkdf2 } from 'xipher'
// Generate a 32 bytes key from the password 'password'
const key = await pbkdf2('password', 32)
```
### `sha256(data)`
Hash data using sha256.
```ts
import { sha256 } from 'xipher'
const hash = await sha256('...')
```
## Security Considerations
You have read this section already pretty much everywhere.
Security is not a thing that is either there or not, it's a process.
Ultimately, there is no algorithm to determine whether an encryption is secure, there is just a bunch of very smart folks trying to break it.
Sure some pattern of attack emerges, but still, there is no life-equation that determines whether a algorithm is secure or not.
As you might have already guess, if there is no algorithm to determine whether an encryption standard is secure, there is no algorithm to determine whether your specific implementation is secure.
So here's the rule, the word "secure" have no meaning, secure from what? secure when? secure how?
Whiteout addressing those questions, the word "secure" is just a buzzword.
Ok then, what should you do?
This library uses the Web Crypto API, which is a well-tested and secure API.
Certain functionality are just wrappers around that API, others are implemented by gluing together those functionalities.
## License
[MIT](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/xipher?style=flat&colorA=1c1c1c&colorB=dead38
[npm-version-href]: https://npmjs.com/package/xipher
[npm-downloads-src]: https://img.shields.io/npm/dm/xipher?style=flat&colorA=1c1c1c&colorB=dead38
[npm-downloads-href]: https://npmjs.com/package/xipher
[bundle-src]: https://img.shields.io/bundlephobia/minzip/xipher?style=flat&colorA=1c1c1c&colorB=dead38
[bundle-href]: https://bundlephobia.com/result?p=xipher
[license-src]: https://img.shields.io/github/license/lucacicada/xipher.svg?style=flat&colorA=1c1c1c&colorB=dead38
[license-href]: https://github.com/lucacicada/xipher/blob/main/LICENSE