RADIUS Lua Agent

Introduction

The RadiusLuaAgent is an asynchronous helper for Lua scripts running within the LogicApp. It is used for sending out RADIUS client requests.

• The RADIUS Agent may be used by any Lua script, regardless of which Service initiated that script.

The RadiusLuaAgent communicates with one or more instances of the RadiusApp which can be used to communicate with one or more external RADIUS servers.

The RadiusLuaAgent communicates with the RadiusApp using the RADIUS-C-… messages.

RADIUS Agent API methods are accessed via the “n2.n2svcd.radius_agent” module:

local radius_agent_api = require "n2.n2svcd.radius_agent"

Configuring RadiusLuaAgent

The RadiusLuaAgent is configured within a LogicApp.

    <?xml version="1.0" encoding="utf-8"?>
    <n2svcd>
      ...
      <applications>
        ...
        <application name="Logic" module="LogicApp">
          <include>
            <lib>../apps/logic/lib</lib>
          </include>
          <parameters>
            ...
            <parameter name="default_radius_app_name" value="RADIUS-CLIENT-AUTH"/>
            <parameter name="radius_app_name_auth" value="RADIUS-CLIENT-AUTH"/>
            <parameter name="radius_app_name_acct" value="RADIUS-CLIENT-ACCT"/>
          </parameters>
          <config>
            <services>
              ...
            </services>
            <agents>
              <agent module="RadiusApp::RadiusLuaAgent" libs="../apps/radius/lib"/>
            </agents>
          </config>
        </application>
        ...
      </application>
      ...
    </n2svcd>

Under normal installation, following agent attributes apply:

In addition, the RadiusLuaAgent must be configured with the name of the RadiusApp with which it will communicate. This is configured within the parameters of the containing LogicApp.

The RadiusLuaAgent API

All methods may raise a Lua Error in the case of exception, including:

• Invalid input parameters supplied by Lua script.
• Unexpected results structure returned from RadiusApp.
• Processing error occurred at RadiusApp.
• Timeout occurred at RadiusApp.

.request_response [Asynchronous]

The request_response method sends a RADIUS request, and returns the response. The following parameters are accepted.

The request_response method returns a RADIUS response object with the following fields.

Example (RADIUS Client Request):

local n2svcd = require "n2.n2svcd"
local radius_agent_api = require "n2.n2svcd.radius_agent"

local soap_args = ...

local result = radius_agent_api.request_response ('auth', 'Access-Request', {
    { name = "User-Name", value = "John.Smith" },
    { name = "User-Password", value = "secret_password" },
    { type = 42, vendor_id = 42, data_type = "integer", value = 789 }
}, false)

soap_response = {}
soap_response['status'] = 'ok'

return soap_response

The above example shows a LogicApp script invoked by a SoapLuaService.

Note that the decoded .attributes array will contain all fields, i.e. the [].name, [].type, [].data_type etc. will all be present.

The only exception will be when decoding attributes which are not part of the core fields defined within N2::RADIUS::Codec. In these cases, the [].name, [].vendor_id, and [].value_name fields will not be present, the [].data_type field value will be unknown, and the [].value will be the raw undecoded attribute value bytes without any interpretation.

.get_first_attribute [Synchronous]

The get_first_attribute method searches an array of attributes, returning the first attribute with matching name or type. The following parameters are accepted.

If a matching attribute is found, the get_first_attribute method returns an attribute object with the following fields.

.get_first_attribute_value [Synchronous]

The get_first_attribute_value method searches an array of attributes, returning the value of the first attribute with matching name or type. The following parameters are accepted.

If a matching attribute is found, the get_first_attribute_value method returns that attribute’s value. For most attributes this will be a SCALAR of the appropriate type. For attributes with data type other this may be a table.

.get_all_attributes [Synchronous]

The get_all_attributes method searches an array of attributes, returning all attributes with matching name or type. The following parameters are accepted.

If at least one matching attribute is found, the get_all_attributes method returns an array of attribute objects as described for get_first_attribute. Otherwise an empty array is returned.

Built-In N2::RADIUS::Codec Packet Types

The following list of packet type names is built-in to the N2::RADIUS::Codec encoding and decoding library. Packet types not in this list may be referenced by numeric code.

Built-In N2::RADIUS::Codec Attributes

The following list of attributes is built-in to the N2::RADIUS::Codec encoding and decoding library.