# crypto-js

**Repository Path**: zhangjun93/crypto-js

## Basic Information

- **Project Name**: crypto-js
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 40
- **Created**: 2022-06-09
- **Last Updated**: 2024-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# crypto-js

## 简介
> 加密算法类库，可以非常方便的在前端进行其所支持的加解密操作。目前crypto-js已支持的算法有：MD5、SHA-1、SHA-256、HMAC、HMAC-MD5、HMAC-SHA1、HMAC-SHA256、PBKDF2等。

![preview.gif](preview/preview.gif)

## 下载安装
```shell
npm install @ohos/crypto-js --save
```
OpenHarmony npm环境配置等更多内容，请参考 [如何安装OpenHarmony npm包](https://gitee.com/openharmony-tpc/docs/blob/master/OpenHarmony_npm_usage.md) 。

## 使用说明
1. 引入依赖
 ```
   import { md5 } from '@ohos/crypto/'
   import { sha1 } from '@ohos/crypto/'
   import { sha256 } from '@ohos/crypto/'
   import { sha512 } from '@ohos/crypto/'
   import { ripemd160 } from '@ohos/crypto/'
 ```
2. md5
 ```
   md5.prototype.hex_md5('message')
 ```
3. sha1
 ```
   sha1.prototype.hex_sha1('message');
 ```
4. sha256
 ```
   sha256.prototype.hex_sha256('message')
 ```
5. sha512
 ```
   sha512.prototype.hex_sha512('message')
 ```
6. ripemd160
 ```
   ripemd160.prototype.hex_rmd160('message')
 ```
7. hmac-md5
 ```
   md5.prototype.hex_hmac_md5('message', 'pwd')
 ```
8. hmac-sha1
 ```
   sha1.prototype.hex_hmac_sha1('message', 'pwd')
 ```
9. hmac-sha256
 ```
   sha256.prototype.hex_hmac_sha256('message', 'pwd')
 ```
10. hmac-sha512
 ```
   sha512.prototype.hex_hmac_sha512('message', 'pwd')
 ```
11. hmac-ripemd160
 ```
   ripemd160.prototype.hex_hmac_rmd160('message', 'pwd')
 ```

## 接口说明
1. md5加密
   `md5.hex_md5(s)`
2. sha1加密
   `sha1.hex_sha1(s)`
3. sha256加密
   `sha256.hex_sha256(s)`
4. sha512加密
   `sha512.hex_sha512(s)`
5. ripemd160加密
   `ripemd160.hex_rmd160(s)`

## 兼容性
支持 OpenHarmony API version 8 及以上版本。

## 目录结构
````
|---- crypto-js  
|     |---- entry  # 示例代码文件夹
|     |---- crypto  # crypto-js库文件夹
|         |---- src
|             |---- main
|                 |---- ets
|                     |---- md5.ets  # md5加密类
|                     |---- ripemd160.ets  # ripemd160加密类
|                     |---- sha1.ets  # sha1加密类
|                     |---- sha256.ets  # sha256加密类
|                     |---- sha512.ets  # sha512加密类
|          |---- index.ets  # 对外接口
|     |---- README.md  # 安装使用方法                    
````

## 贡献代码
使用过程中发现任何问题都可以提 [Issue](https://gitee.com/openharmony-sig/crypto-js/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://gitee.com/openharmony-sig/crypto-js/pulls) 。

## 开源协议
本项目基于 [MIT License](https://gitee.com/openharmony-sig/crypto-js/blob/master/LICENSE) ，请自由地享受和参与开源。