mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
106 lines
2.9 KiB
TypeScript
106 lines
2.9 KiB
TypeScript
// Type definitions for node-radius
|
|
// Project: https://github.com/retailnext/node-radius
|
|
// Definitions by: Peter Harris <https://github.com/codeanimal>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusdecodeargs} for more info.
|
|
**/
|
|
export declare function decode(args: DecodeArgsWithSecret): RadiusPacket;
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusdecode_without_secretargs} for more info.
|
|
**/
|
|
export declare function decode_without_secret(args: DecodeArgs): RadiusPacket;
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusencodeargs} for more info.
|
|
**/
|
|
export declare function encode(args: EncodeArgs): Buffer;
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusencode_responseargs} for more info.
|
|
**/
|
|
export declare function encode_response(args: EncodeResponseArgs): Buffer;
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusverify_responseargs} for more info.
|
|
**/
|
|
export declare function verify_response(args: VerifyResponseArgs): boolean;
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusadd_dictionarypath} for more info.
|
|
*
|
|
* @param path Can be either a path to a file or a directory.
|
|
**/
|
|
export declare function add_dictionary(path: string): void;
|
|
|
|
export declare function unload_dictionaries(): void;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusdecode_without_secretargs} for more info.
|
|
**/
|
|
interface DecodeArgs {
|
|
packet: Buffer;
|
|
}
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusdecodeargs} for more info.
|
|
**/
|
|
interface DecodeArgsWithSecret extends DecodeArgs {
|
|
secret: string;
|
|
}
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusencodeargs} for more info.
|
|
**/
|
|
interface EncodeArgs {
|
|
code: string;
|
|
secret: string;
|
|
identifier?: number;
|
|
/**
|
|
* This can be an object: { attribute_name: attribute_value, ... },
|
|
* an array within an array: [ [ attribute_name, attribute_value ], ... ],
|
|
* or if you haven't loaded a dictionary for the attributes: [ [ attribute_id, Buffer ], ... ].
|
|
*
|
|
* Tag field-attributes can be specified like so: [ [ attribute_name, tag_number, attribute_value ] ... ]
|
|
**/
|
|
attributes?: any;
|
|
add_message_authenticator?: boolean;
|
|
}
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusencode_responseargs} for more info.
|
|
**/
|
|
interface EncodeResponseArgs {
|
|
packet: RadiusPacket;
|
|
code: string;
|
|
secret: string;
|
|
attributes?: any;
|
|
}
|
|
|
|
/**
|
|
* {@link https://github.com/retailnext/node-radius#radiusverify_responseargs} for more info.
|
|
**/
|
|
interface VerifyResponseArgs {
|
|
request: Buffer;
|
|
response: Buffer;
|
|
secret: string;
|
|
}
|
|
|
|
interface RadiusPacket {
|
|
code: string;
|
|
identifier: number;
|
|
length: number;
|
|
attributes: any;
|
|
raw_attributes: Array<Array<any>>
|
|
}
|