js-wowemu-auth/README.md
2020-12-22 05:15:25 +01:00

35 lines
692 B
Markdown

# js-wowemu-auth
SRP implementation for WoW Server authentication in Typescript
Impired by [the PHP version](https://github.com/Laizerox/php-wowemu-auth/)
## installation
```
yarn add js-wowemu-auth
```
## usage
### register
```ts
import { register } from 'js-wowemu-auth'
register('username', 'password')
```
This will return
```ts
{
salt: "63f86e2b89cec2f95d1d67abd7148309787b98847c55f6e68fcfdaebdadcc505",
verifier: "636a2087700468caded99874ea45cee20e2b70a7a7edf522d8e6eb0f1a1b15fc"
}
```
`username` is to be set to the column `username` in `realm.account`
`salt` is to be set to the column `s` in `realm.account`
`verifier`is to be set to the column `v` in `realm.account`