Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::Server::AuthUsercContributedPPerlSDrver::Authentication::External(3)

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

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__

perl v5.24.1			 OpenXPKI::Server::Authentication::External(3)

Name | Description | Functions | Configuration

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Server::Authentication::External&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help