IPWorks Auth 2020 Node.js Edition

Questions / Feedback?

AuthMechanism Property

The authentication mechanism to be used when connecting to the RADIUS server.

Syntax

 radius.getAuthMechanism([callback])
 radius.setAuthMechanism( authMechanism, [callback])

Possible Values

  0 (ramMSCHAPv2), 
  1 (ramPAP), 
  2 (ramPEAPv0), 
  3 (ramEAPTLS)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAuthMechanism([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAuthMechanism([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property defines the authentication mechanism used when connecting to the RADIUS server. Possible values are:

0 (ramMSCHAPv2 - default) Microsoft Challenge Authentication Protocol v2
1 (ramPAP) Password Authentication Protocol
2 (ramPEAPv0) Protected Extensible Authentication Protocol with MSCHAPv2 inner authentication
3 (ramEAPTLS) Extensible Authentication Protocol with TLS

When set to ramEAPTLS the SSLCert* properties must be set to the client certificate used to authenticate to the server.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 Node.js Edition - Version 20.0 [Build 8155]