Class SRP

Hierarchy

Index

Constructors

constructor

new SRP(): SRP
Returns SRP

Properties

`Static` `Readonly` params

params: { 1024: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }; 1536: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }; 2048: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }; 3072: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }; 4096: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }; 6244: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }; 8192: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }; hap: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string } } = srpParams

Type declaration

1024: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }
- N: BigInteger
- N_length_bits: number
- g: BigInteger
- hash: string
1536: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }
- N: BigInteger
- N_length_bits: number
- g: BigInteger
- hash: string
2048: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }
- N: BigInteger
- N_length_bits: number
- g: BigInteger
- hash: string
3072: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }
- N: BigInteger
- N_length_bits: number
- g: BigInteger
- hash: string
4096: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }
- N: BigInteger
- N_length_bits: number
- g: BigInteger
- hash: string
6244: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }
- N: BigInteger
- N_length_bits: number
- g: BigInteger
- hash: string
8192: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }
- N: BigInteger
- N_length_bits: number
- g: BigInteger
- hash: string
hap: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }
- N: BigInteger
- N_length_bits: number
- g: BigInteger
- hash: string

Methods

`Static` computeVerifier

computeVerifier(params: SrpParams, salt: Buffer, I: Buffer, P: Buffer): Buffer
The verifier is calculated as described in Section 3 of [SRP-RFC]. We give the algorithm here for convenience.

The verifier (v) is computed based on the salt (s), user name (I), password (P), and group parameters (N, g).
```
    x = H(s | H(I | ":" | P))
    v = g^x % N
```
Returns
Parameters
- params: SrpParams
  
  Group parameters, with .N, .g, .hash
- salt: Buffer
- I: Buffer
  
  User identity
- P: Buffer
  
  User password
Returns Buffer
- Defined in srp.ts:99

`Static` genKey

genKey(callback: GenKeyCallback): void
Generate a random key with a length of 32 bytes

Returns
Parameters
- callback: GenKeyCallback
Returns void
- Defined in srp.ts:114
genKey(bytes: number, callback: GenKeyCallback): void
Generate a random key.

Returns
Parameters
- bytes: number
  
  Length of key
- callback: GenKeyCallback
Returns void
- Defined in srp.ts:122
genKey(bytes?: number): Promise<Buffer>
Generate a random key.

Returns
Parameters
- Optional bytes: number
  
  Length of key. Defaults to 32.
Returns Promise<Buffer>
- Defined in srp.ts:129

Class SRP

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SRP

Properties

Static Readonly params

Type declaration

1024: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }

N: BigInteger

N_length_bits: number

g: BigInteger

hash: string

1536: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }

N: BigInteger

N_length_bits: number

g: BigInteger

hash: string

2048: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }

N: BigInteger

N_length_bits: number

g: BigInteger

hash: string

3072: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }

N: BigInteger

N_length_bits: number

g: BigInteger

hash: string

4096: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }

N: BigInteger

N_length_bits: number

g: BigInteger

hash: string

6244: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }

N: BigInteger

N_length_bits: number

g: BigInteger

hash: string

8192: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }

N: BigInteger

N_length_bits: number

g: BigInteger

hash: string

hap: { N: BigInteger; N_length_bits: number; g: BigInteger; hash: string }

N: BigInteger

N_length_bits: number

g: BigInteger

hash: string

Methods

Static computeVerifier

Returns

Parameters

params: SrpParams

salt: Buffer

I: Buffer

P: Buffer

Returns Buffer

Static genKey

Returns

Parameters

callback: GenKeyCallback

Returns void

Returns

Parameters

bytes: number

callback: GenKeyCallback

Returns void

Returns

Parameters

Optional bytes: number

Returns Promise<Buffer>

Settings

Member Visibility

Theme

`Static` `Readonly` params

`Static` computeVerifier

`Static` genKey

`Optional` bytes: number