Skip to content

Commit 0f2f561

Browse files
tvdijentvdijen
committed
deploy: 56b0c9b 
1 parent 6e01bad commit 0f2f561

1 file changed

Lines changed: 289 additions & 0 deletions

File tree

‎devel/core/authproc_attributedump.html‎

Lines changed: 289 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,289 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta http-equiv="content-type" content="text/html; charset=utf-8">
5+
<meta http-equiv="Content-Language" content="en">
6+
<meta name="google-site-verification" content="2S8M18BgYs8cLRL6ClTrfW_xGxfFtMZu2b2jhjrNlss">
7+
8+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
9+
<meta name="viewport" content="width=device-width, initial-scale=1">
10+
11+
<title>SimpleSAMLphp Documentation</title>
12+
13+
<link rel="stylesheet" href="/res/css/style.css">
14+
<link rel="stylesheet" href="/res/css/layout.css">
15+
</head>
16+
<body>
17+
<header>
18+
<div id="header">
19+
<div class="right">
20+
<form action="https://www.google.com/cse" method="get" style="margin-top: 2.5rem; margin-right: 2rem">
21+
<input name="cx" type="hidden" value="004202914224971217557:8ks4jjstupq"/>
22+
<input name="siteurl" type="hidden" value="www.google.com/cse/home?cx=004202914224971217557:8ks4jjstupq"/>
23+
<input name="adkw" type="hidden" value="AELymgVJ6Sk-kOvUjbxvgShTLwiFlma2evFuVCh0r8q23vn_4eVnkcdnPfbgMvYUTpJpVlb-KkGAKkbn0i-AlWHsVRR9O0J4CNb6cXFkEKRdjXxsC_NlVD4"/>
24+
<input name="q" placeholder="Search" type="search" value=""/>
25+
</form>
26+
</div>
27+
<div class="v-center logo-header">
28+
<div id="logo">
29+
<a href="https://simplesamlphp.org" style="color: #fff; text-decoration: none">
30+
<span class="simple">
31+
Simple
32+
</span>
33+
<span class="saml">
34+
SAML
35+
</span>
36+
<span class="simple">
37+
php
38+
</span>
39+
</a>
40+
</div>
41+
</div>
42+
</div>
43+
<!-- Grey header bar below -->
44+
<nav>
45+
<div id="headerbar" style="clear: both">
46+
<p id="breadcrumb">
47+
<a href="https://simplesamlphp.org">
48+
Home
49+
</a>
50+
» Documentation
51+
</p>
52+
<div class="mtoolbar">
53+
<div class="menuitem">
54+
<a href="/docs/2.4/index.html">
55+
2.4 (stable)
56+
</a>
57+
</div>
58+
<div class="menuitem">
59+
<a href="/docs/2.3/index.html">
60+
2.3
61+
</a>
62+
</div>
63+
<div class="menuitem">
64+
<a href="/docs/2.2/index.html">
65+
2.2
66+
</a>
67+
</div>
68+
<div class="menuitem first">
69+
<a href="/docs/devel/index.html">
70+
devel
71+
</a>
72+
</div>
73+
<div class="menuitem last">
74+
<a href="/docs/contributed_modules.html">
75+
Contributed modules
76+
</a>
77+
</div>
78+
</div>
79+
<br style="height: 0px; clear: both"/>
80+
</div>
81+
<!-- /#headerbar -->
82+
</nav>
83+
<div id="content">
84+
</div>
85+
</header>
86+
<main><h1 id="coreattributedump">
87+
<code>
88+
core:AttributeDump
89+
</code>
90+
</h1>
91+
<p>
92+
Filter that outputs to the system log file attributes and their values that match a given criteria.
93+
</p>
94+
<p>
95+
This is particularly useful for adding debug points in your list of authproc filters as you are configuring your SimpleSAMLphp.
96+
</p>
97+
<h2 id="parameters">
98+
Parameters
99+
</h2>
100+
<dl>
101+
<dt>
102+
<code>
103+
class
104+
</code>
105+
(required)
106+
</dt>
107+
<dd>
108+
This is the name of the filter.
109+
It must be
110+
<code>
111+
core:AttributeDump
112+
</code>
113+
.
114+
</dd>
115+
<dt>
116+
<code>
117+
attributes
118+
</code>
119+
</dt>
120+
<dd>
121+
An array of attribute names that are to be output to the SimpleSAMLphp logs.
122+
If not specified, and
123+
<code>
124+
attributesRegex
125+
</code>
126+
is not specified, all attributes will be output.
127+
</dd>
128+
<dt>
129+
<code>
130+
attributesRegex
131+
</code>
132+
</dt>
133+
<dd>
134+
An array of regular expressions. Any attribute name that matches any of the regular expressions
135+
in this list are to be output to the SimpleSAMLphp logs.
136+
If not specified, and
137+
<code>
138+
attributes
139+
</code>
140+
is also not specified, all attributes will be output.
141+
</dd>
142+
<dt>
143+
<code>
144+
prefix
145+
</code>
146+
</dt>
147+
<dd>
148+
A string to prefix each log line to be outputted.
149+
Defaults to "AttributeDump".
150+
</dd>
151+
<dt>
152+
<code>
153+
logLevel
154+
</code>
155+
</dt>
156+
<dd>
157+
The level to log at. For the message to appear in the SimpleSAMLphp log files it needs to be at a level
158+
equal to or higher than the log value you've configured in your
159+
<code>
160+
config.php
161+
</code>
162+
.
163+
Valid values are: "emergency", "critical", "alert", "error", "warning", "notice", "info" or "debug".
164+
</dd>
165+
</dl>
166+
<h2 id="examples">
167+
Examples
168+
</h2>
169+
<p>
170+
If no attribute list or list of attribute regular expressions is provided, it will simply dump all attributes:
171+
</p>
172+
<div class="codehilite">
173+
<pre><span></span><code> 'authproc' =&gt; [
174+
50 =&gt; [
175+
'class' =&gt; 'core:AttributeDump',
176+
],
177+
],
178+
</code></pre>
179+
</div>
180+
<p>
181+
This will output the
182+
<code>
183+
uid
184+
</code>
185+
and
186+
<code>
187+
groups
188+
</code>
189+
attributes only to the logs:
190+
</p>
191+
<div class="codehilite">
192+
<pre><span></span><code> 'authproc' =&gt; [
193+
50 =&gt; [
194+
'class' =&gt; 'core:AttributeDump',
195+
'attributes' =&gt; ['uid', 'groups'],
196+
],
197+
],
198+
</code></pre>
199+
</div>
200+
<p>
201+
This will output any attribute that ends in the letter
202+
<code>
203+
n
204+
</code>
205+
(eg.
206+
<code>
207+
fn
208+
</code>
209+
,
210+
<code>
211+
sn
212+
</code>
213+
,
214+
<code>
215+
cn
216+
</code>
217+
):
218+
</p>
219+
<div class="codehilite">
220+
<pre><span></span><code> 'authproc' =&gt; [
221+
50 =&gt; [
222+
'class' =&gt; 'core:AttributeDump',
223+
'attributesRegex' =&gt; ['/n$/'],
224+
],
225+
],
226+
</code></pre>
227+
</div>
228+
<p>
229+
This will output the
230+
<code>
231+
uid
232+
</code>
233+
and
234+
<code>
235+
groups
236+
</code>
237+
attributes, as well as any attribute that ends in the letter
238+
<code>
239+
n
240+
</code>
241+
(eg.
242+
<code>
243+
fn
244+
</code>
245+
,
246+
<code>
247+
sn
248+
</code>
249+
,
250+
<code>
251+
cn
252+
</code>
253+
) to the logs:
254+
</p>
255+
<div class="codehilite">
256+
<pre><span></span><code> 'authproc' =&gt; [
257+
50 =&gt; [
258+
'class' =&gt; 'core:AttributeDump',
259+
'attributes' =&gt; ['uid', 'groups'],
260+
'attributesRegex' =&gt; ['/n$/'],
261+
],
262+
],
263+
</code></pre>
264+
</div>
265+
<p>
266+
Optionally, you can specify a prefix to the log message and a log level to log at:
267+
</p>
268+
<div class="codehilite">
269+
<pre><span></span><code> 'authproc' =&gt; [
270+
49 =&gt; [
271+
'class' =&gt; 'core:AttributeAdd',
272+
[...]
273+
],
274+
275+
50 =&gt; [
276+
'class' =&gt; 'core:AttributeDump',
277+
'prefix' =&gt; 'After running AttributeAdd but before applying AttributeLimit filter',
278+
'logLevel' =&gt; 'debug',
279+
],
280+
281+
51 =&gt; [
282+
'class' =&gt; 'core:AttributeLimit',
283+
[...]
284+
],
285+
],
286+
</code></pre>
287+
</div>
288+
</main></body>
289+
</html>

0 commit comments

Comments
 (0)