GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  OPENXPKI::SERVER::AUTHENTICATION::EXTERNAL (3)

.ds Aq ’

Name

OpenXPKI::Server::Authentication::External - support for external authentication.

CONTENTS

Description

This is the class which supports OpenXPKI with an authentication method via an external program. The parameters are passed as a hash reference.

Functions

    new

is the constructor. It requires the config prefix as single argument.

Configuration

    Exit code only / static role

In this mode, you need to specify the role for the user as a static value inside the configuration. The Username/Password is passed via the environment.



 MyHandler:
   type: External
   label: My Auth Handler
   command: /path/to/your/script
   role: RA Operator
   env:
        LOGIN: __USER__
        PASSWD: __PASSWD__



The login will succeed if the script has exitcode 0. Here is a stub that logs in user john with password doe:



  #!/bin/bash

  if [ "$LOGIN" == "john" ] && [ "$PASSWD" == "doe" ]; then
    exit 0;
  fi;

  exit 1;



    Output evaluation

If you do not set the role in the configuration, it is determined from the scripts output. Trailing spaces are always stripped by the handler internally. If your output needs more postprocessing (e.g. strip away a prefix), you can specify a pattern and replacement, that are placed into a perl regex and applied to the output.



 MyHandler:
   type: External
   label: My Auth Handler
   command: /path/to/your/script
   role: 
   pattern: role_
   replacement: 
   env:
        LOGIN: __USER__
        PASSWD: __PASSWD__



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 OPENXPKI::SERVER::AUTHENTICATION::EXTERNAL (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.