Difference between revisions of "Unit Authentication"

From Ultibo.org
Jump to: navigation, search
 
(13 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
−
'''Ultibo Authentication interface unit'''
+
'''Ultibo Authentication Interface unit'''
−
 
+
−
''To be documented''
+
  
 
=== Constants ===
 
=== Constants ===
Line 20: Line 18:
 
| <code>AUTHENTICATOR_FLAG_NONE = $00000000;</code>
 
| <code>AUTHENTICATOR_FLAG_NONE = $00000000;</code>
 
| style="width: 50%;"|&nbsp;
 
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>AUTHENTICATOR_FLAG_USERNAME = $00000001; {Authenticator supports usernames</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>AUTHENTICATOR_FLAG_PASSWORD = $00000002; {Authenticator supports passwords</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>AUTHENTICATOR_FLAG_TOKEN = $00000004;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>AUTHENTICATOR_FLAG_KEY = $00000008;</code>
 +
| Authenticator supports tokens
 +
|-
 +
| <code>AUTHENTICATOR_FLAG_CACHE = $00000010;</code>
 +
| Authenticator supports token and value caching (eg session caching)
 +
|-
 +
| <code>AUTHENTICATOR_FLAG_LOCAL = $00000020;</code>
 +
| Authenticator maintains a local list of usernames, passwords or tokens
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''Authenticator mode''' <code> AUTHENTICATOR_MODE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>AUTHENTICATOR_MODE_UNKNOWN = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>AUTHENTICATOR_MODE_BASIC = 1;</code>
 +
| Password only authentication
 +
|-
 +
| <code>AUTHENTICATOR_MODE_USER = 2;</code>
 +
| Username and password authentication
 +
|-
 +
| <code>AUTHENTICATOR_MODE_SESSION = 3;</code>
 +
| Session authentication
 
|-
 
|-
 
|}
 
|}
Line 28: Line 64:
 
----
 
----
  
−
''None defined''
 
  
−
=== Class definitions ===
+
'''Authentication check password event'''
−
----
+
  
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TCheckPasswordEvent = function(ASource:TAuthenticator; const APassword:String):LongWord of Object;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
  
−
'''Authentication specific classes'''
+
'''Authentication check username event'''
  
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
| <code>TAuthenticator = class(TObject)</code>
+
| <code>TCheckUsernameEvent = function(ASource:TAuthenticator; const AUsername:String):LongWord of Object;</code>
 
| style="width: 40%;"|
 
| style="width: 40%;"|
 
|-
 
|-
 
|}
 
|}
  
−
'''Authenticator'''
+
'''Authentication check user password event'''
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
<code>TAuthenticator = class(TObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| <code>TCheckUserPasswordEvent = function(ASource:TAuthenticator; const AUsername,APassword:String):LongWord of Object;</code>
 +
| style="width: 40%;"|
 
|-
 
|-
−
| <code>constructor Create;</code>
+
|}
−
| style="width: 50%;"|&nbsp;
+
 
 +
'''Authentication check token event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
| <code>destructor Destroy; override;</code>
+
| <code>FCheckTokenEvent = function(ASource:TAuthenticator; const AToken,AValue:String):LongWord of Object;</code>
−
| &nbsp;
+
| style="width: 40%;"|
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
|}
 +
 
 +
'''Authentication create token event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
| <code>FLock:TCriticalSectionHandle;</code>
+
| <code>TCreateTokenEvent = function(ASource:TAuthenticator; const AValue:String; var AToken:String; ATimeout:LongWord):LongWord of Object;</code>
−
| &nbsp;
+
| style="width: 40%;"|
 
|-
 
|-
−
|colspan="2"|&nbsp;  
+
|}
 +
 
 +
'''Authentication delete token event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
| <code>FFlags:LongWord;</code>
+
| <code>TDeleteTokenEvent = function(ASource:TAuthenticator; const AToken,AValue:String):LongWord of Object;</code>
−
| &nbsp;
+
| style="width: 40%;"|
 
|-
 
|-
−
|colspan="2"|&nbsp;
+
|}
 +
 
 +
'''Authentication check key event'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
| <code>procedure SetFlags(AFlags:LongWord);</code>
+
| <code>TCheckKeyEvent = function(ASource:TAuthenticator; AData:Pointer; ASize:LongWord):LongWord of Object;</code>
−
| &nbsp;
+
| style="width: 40%;"|
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property Flags:LongWord read FFlags write SetFlags;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function UsernamePrompt:String; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function PasswordPrompt(const AUsername:String):String; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function CheckUsername(const AUsername:String):LongWord; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function CheckPassword(const AUsername,APassword:String):LongWord; virtual;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
<br />
  
−
'''Null authenticator'''
+
=== Class definitions ===
 +
----
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
  
−
<code>TNullAuthenticator = class(TAuthenticator)</code>
+
'''Authentication specific classes'''
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
 
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
|colspan="2"|Note: An authenticator module that accepts any username and password.
+
| [[TAuthenticator|<code>TAuthenticator = class(TObject)</code>]]
 
|-
 
|-
−
|colspan="2"|&nbsp;  
+
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TNullAuthenticator|<code>TNullAuthenticator = class(TAuthenticator)</code>]]
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TBasicAuthenticator|<code>TBasicAuthenticator = class(TAuthenticator)</code>]]
 
|-
 
|-
−
| <code>function UsernamePrompt:String; override;</code>
+
|}
−
| style="width: 50%;"|&nbsp;
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TLocalBasicAuthenticator|<code>TLocalBasicAuthenticator = class(TAuthenticator)</code>]]
 
|-
 
|-
−
| <code>function PasswordPrompt(const AUsername:String):String; override;</code>
+
|}
−
| &nbsp;
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TUserAuthenticator|<code>TUserAuthenticator = class(TAuthenticator)</code>]]
 
|-
 
|-
−
|colspan="2"|&nbsp;
+
|}
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TLocalUserAuthenticator|<code>TLocalUserAuthenticator = class(TAuthenticator)</code>]]
 
|-
 
|-
−
| <code>function CheckUsername(const AUsername:String):LongWord; override;</code>
+
|}
−
| &nbsp;
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TSessionAuthenticator|<code>TSessionAuthenticator = class(TAuthenticator)</code>]]
 
|-
 
|-
−
| <code>function CheckPassword(const AUsername,APassword:String):LongWord; override;</code>
+
|}
−
| &nbsp;
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| [[TLocalSessionAuthenticator|<code>TLocalSessionAuthenticator = class(TAuthenticator)</code>]]
 
|-
 
|-
 
|}
 
|}
−
</div></div>
 
 
<br />
 
<br />
  

Latest revision as of 05:34, 23 October 2025

Return to Unit Reference


Description

Ultibo Authentication Interface unit

Constants


Authenticator flag AUTHENTICATOR_FLAG_*
AUTHENTICATOR_FLAG_NONE = $00000000;  
AUTHENTICATOR_FLAG_USERNAME = $00000001; {Authenticator supports usernames  
AUTHENTICATOR_FLAG_PASSWORD = $00000002; {Authenticator supports passwords  
AUTHENTICATOR_FLAG_TOKEN = $00000004;  
AUTHENTICATOR_FLAG_KEY = $00000008; Authenticator supports tokens
AUTHENTICATOR_FLAG_CACHE = $00000010; Authenticator supports token and value caching (eg session caching)
AUTHENTICATOR_FLAG_LOCAL = $00000020; Authenticator maintains a local list of usernames, passwords or tokens


Authenticator mode AUTHENTICATOR_MODE_*
AUTHENTICATOR_MODE_UNKNOWN = 0;  
AUTHENTICATOR_MODE_BASIC = 1; Password only authentication
AUTHENTICATOR_MODE_USER = 2; Username and password authentication
AUTHENTICATOR_MODE_SESSION = 3; Session authentication


Type definitions


Authentication check password event

TCheckPasswordEvent = function(ASource:TAuthenticator; const APassword:String):LongWord of Object;

Authentication check username event

TCheckUsernameEvent = function(ASource:TAuthenticator; const AUsername:String):LongWord of Object;

Authentication check user password event

TCheckUserPasswordEvent = function(ASource:TAuthenticator; const AUsername,APassword:String):LongWord of Object;

Authentication check token event

FCheckTokenEvent = function(ASource:TAuthenticator; const AToken,AValue:String):LongWord of Object;

Authentication create token event

TCreateTokenEvent = function(ASource:TAuthenticator; const AValue:String; var AToken:String; ATimeout:LongWord):LongWord of Object;

Authentication delete token event

TDeleteTokenEvent = function(ASource:TAuthenticator; const AToken,AValue:String):LongWord of Object;

Authentication check key event

TCheckKeyEvent = function(ASource:TAuthenticator; AData:Pointer; ASize:LongWord):LongWord of Object;


Class definitions


Authentication specific classes

TAuthenticator = class(TObject)
TNullAuthenticator = class(TAuthenticator)
TBasicAuthenticator = class(TAuthenticator)
TLocalBasicAuthenticator = class(TAuthenticator)
TUserAuthenticator = class(TAuthenticator)
TLocalUserAuthenticator = class(TAuthenticator)
TSessionAuthenticator = class(TAuthenticator)
TLocalSessionAuthenticator = class(TAuthenticator)


Public variables

None defined

Function declarations


Initialization functions 

procedure AuthInit;
Description: To be documented
Note None documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_Authentication&oldid=6049"