RADIUS Class
Properties Methods Events Configuration Settings Errors
The RADIUS class provides an easy way to authenticate users.
Syntax
class ipworksauth.RADIUS
Remarks
The RADIUS component implements support for Remote Authentication Dial In User Service (RADIUS).
Authentication
The class can be used to authenticate users with a RADIUS server. To begin set the following properties:
To authenticate the user call authenticate. If the method returns without error the user was successfully authenticated. The Attr* properties will hold information about the attributes in the response.The auth_mechanism property may be set to specify the authentication mechanism used.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| attr_count | The number of records in the Attr arrays. |
| attr_type | The type of the attribute. |
| attr_name | A text description of the attribute type. |
| attr_value | The attribute value. |
| auth_mechanism | The authentication mechanism to be used when connecting to the RADIUS server. |
| eap_anonymous_identity | The identity to use when using PEAP or EAP-TLS. |
| local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| local_port | The UDP port in the local host where UDPPort binds. |
| password | The user's password. |
| remote_host | The address of the remote host. Domain names are resolved to IP addresses. |
| remote_port | The port for the RADIUS server (default is 1812). |
| shared_secret | The RADIUS shared secret. |
| ssl_cert_encoded | The certificate (PEM/base64 encoded). |
| ssl_cert_store | The name of the certificate store for the client certificate. |
| ssl_cert_store_password | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| ssl_cert_store_type | The type of certificate store for this certificate. |
| ssl_cert_subject | The subject of the certificate used for client authentication. |
| timeout | A timeout for the class. |
| user | The name of the user to authenticate. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| authenticate | Authenticates the user. |
| config | Sets or retrieves a configuration setting. |
| do_events | Processes events from the internal message queue. |
| interrupt | Interrupt the current method. |
| reset | Resets the class properties to their default values. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_attribute | Fires for each attribute that is received. |
| on_error | Information about errors during data delivery. |
| on_log | Fires with log information during processing. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| SendMessageAuthenticator | Whether to send the Message-Authenticator attribute. |
| CaptureIPPacketInfo | Used to capture the packet information. |
| DestinationAddress | Used to get the destination address from the packet information. |
| DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the class binds. |
| MaxPacketSize | The maximum length of the packets that can be received. |
| QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
| QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
| ShareLocalPort | If set to True, allows more than one instance of the class to be active on the same local port. |
| SourceIPAddress | Used to set the source IP address used when sending a packet. |
| SourceMacAddress | Used to set the source MAC address used when sending a packet. |
| UseConnection | Determines whether to use a connected socket. |
| UseIPv6 | Whether or not to use IPv6. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |