~ubuntu-branches/ubuntu/saucy/lcmaps-plugins-voms/saucy

« back to all changes in this revision

Viewing changes to doc/lcmaps_voms_localgroup.mod.8

  • Committer: Package Import Robot
  • Author(s): Dennis van Dok
  • Date: 2012-11-06 00:50:24 UTC
  • Revision ID: package-import@ubuntu.com-20121106005024-0513ko4vca18a53l
Tags: upstream-1.5.5
ImportĀ upstreamĀ versionĀ 1.5.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" In .TH, FOO should be all caps, SECTION should be 1-8, maybe w/ subsection
 
2
.\" other parms are allowed: see man(7), man(1)
 
3
.\"
 
4
.\" This template provided by Tom Christiansen <tchrist@jhereg.perl.com>.
 
5
.\" 
 
6
.TH LCMAPS_VOMS_LOCALGROUP.MOD 8 "March 7, 2012" "Stichting FOM/Nikhef" "Site Access Control"
 
7
.SH NAME
 
8
lcmaps_voms_localgroup.mod \- LCMAPS plugin to switch user identity based on VOMS credentials by local groups
 
9
.SH SYNOPSIS
 
10
.nh
 
11
.ad l
 
12
.B lcmaps_voms_localgroup.mod
 
13
.RB [ -groupmapfile
 
14
.IR groupmapfile ]
 
15
.RB [ --map-to-secondary-groups ]
 
16
.RB [ -mapall ]
 
17
.RB [ -mapmin
 
18
.IR "number of minimal mappings" ]
 
19
.hy
 
20
.ad b
 
21
.SH DESCRIPTION
 
22
The VOMS localgroup acquisition plugin is a 'VOMS-aware' plugin.  It uses the
 
23
VOMS information to gather primary and secondary Group IDs.  This is
 
24
accomplished by matching VOMS FQANs in the so-called groupmapfile (gridmapfile
 
25
style) with the credentials presented by the user. The resulting list of groups
 
26
will be looked up in the /etc/groups and/or LDAP directories to determine which
 
27
Group IDs to be added as a mapping result.
 
28
 
 
29
When enabled, the plug-in will map all the FQANs of the user to secondary Group IDs. There will be no primary Group ID set by this plug-in. This option is off by default, thus by default the plug-in will always set the first FQAN
 
30
 
 
31
.SH  OPTIONS
 
32
.TP
 
33
.BI "-groupmapfile " groupmapfile
 
34
This option is used to determine the groupmapfile path. The plug-in will open the file and use the content for the FQAN to Group ID mapping. The same formatting rules of the grid-mapfile apply to the groupmapfile. Provide a full path.
 
35
.TP
 
36
.BI "--map-to-secondary-groups"
 
37
When enabled, the plug-in will map all the FQANs of the user to secondary Group IDs. There will be no primary Group ID set by this plug-in when enabled.
 
38
.TP
 
39
.BI "-mapall"
 
40
When enabled, a failure will be triggered if not all of the FQANs could be mapped to primary or secondary Group IDs.
 
41
.TP
 
42
.BI "-mapmin " "number of minimal mappings"
 
43
When set the \fBnumber of minimal mappings\fR will be enforced by the plug-in to ensure that at least this number of FQAN to Group ID mappings has occured. When absent...
 
44
 
 
45
 
 
46
.SH "RETURN VALUES"
 
47
.TP
 
48
.B LCMAPS_MOD_SUCCESS
 
49
Success.
 
50
.TP
 
51
.B LCMAPS_MOD_FAIL
 
52
Failure.
 
53
.SH BUGS
 
54
Please report any errors to the Nikhef Grid Middleware Security Team
 
55
<grid-mw-security-support@nikhef.nl>.
 
56
.SH "SEE ALSO"
 
57
.BR lcmaps.db (5), 
 
58
.BR lcmaps (3).
 
59
.SH AUTHORS
 
60
LCMAPS and the LCMAPS plug-ins were written by the Grid Middleware Security Team 
 
61
<grid-mw-security@nikhef.nl>.