I'm a doctor, not a mechanic

UE3:BasicWebAdminAuth (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> BasicWebAdminAuth
Package: 
WebAdmin
Implemented interfaces
IWebAdminAuth

Default "simple" authentication handler implementation.

Copyright 2008 Epic Games, Inc. All Rights Reserved

Author: Michiel 'elmuerte' Hendriks

Properties[edit]

ac[edit]

Type: AccessControl


RequireUsername[edit]

Type: array<string>

Modifiers: config

If this is not empty the simple authentication handler will require this username. Otherwise any username accepted by the current AccessControl will be accepted. In case of the standard AccessControl this means that any username is ok.

users[edit]

Type: array<BasicWebAdminUser>


worldinfo[edit]

Type: WorldInfo


Instance functions[edit]

authenticate[edit]

function IWebAdminUser authenticate (string username, string password, out string errorMsg)

Specified by: IWebAdminAuth.authenticate

(Description copied from IWebAdminAuth.authenticate)
Try to log in a user with the provided credentials

Parameters:

  • username -
  • password -
  • errorMsg - can be set to a friendly error message or reason why authentication failed

Returns:

none when authentication failed, otherwise the created user instance

cleanup[edit]

function cleanup ()

Specified by: IWebAdminAuth.cleanup

Cleanup (prepare for being destroyed)

init[edit]

function init (WorldInfo wi)

Specified by: IWebAdminAuth.init

Initialize the authentication handler

logout[edit]

function bool logout (IWebAdminUser user)

Specified by: IWebAdminAuth.logout

(Description copied from IWebAdminAuth.logout)
Logout the given user. A user does not explicitly log out.

Returns:

true when the user was succesfully logged out.

validate[edit]

function bool validate (string username, string password, out string errorMsg)

Specified by: IWebAdminAuth.validate

(Description copied from IWebAdminAuth.validate)
Like authenticate(...) except that the user is not explicitly logged in (or created). This will be used to re-validate an already existing user. For example in the case a time out was triggered and the user needs to re-enter his/her password.

Parameters:

  • username -
  • password -
  • errorMsg - can be set to a friendly error message or reason why authentication failed

validateUser[edit]

function bool validateUser (IWebAdminUser user, out string errorMsg)

Specified by: IWebAdminAuth.validateUser

(Description copied from IWebAdminAuth.validateUser)
Validate the given user. This will be used to check if the IWebAdminUser is still valid, for example to check if the user wasn't deleted in the mean while.

Parameters:

  • user - the user instance to validate
  • errorMsg - can be set to a friendly error message or reason why authentication failed