94 lines
5.3 KiB
HTML
94 lines
5.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<title>documentation:2.0:mail2f</title>
|
|
<meta name="generator" content="DokuWiki"/>
|
|
<meta name="robots" content="index,follow"/>
|
|
<meta name="keywords" content="documentation,2.0,mail2f"/>
|
|
<link rel="search" type="application/opensearchdescription+xml" href="lib/exe/opensearch.html" title="LemonLDAP::NG"/>
|
|
<link rel="start" href="mail2f.html"/>
|
|
<link rel="contents" href="mail2f.html" title="Sitemap"/>
|
|
<link rel="stylesheet" type="text/css" href="lib/exe/css.php.t.bootstrap3.css"/>
|
|
<!-- //if:usedebianlibs
|
|
<link rel="stylesheet" type="text/css" href="/javascript/bootstrap/css/bootstrap.min.css" />
|
|
//elsif:useexternallibs
|
|
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css"></script>
|
|
//elsif:cssminified
|
|
<link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.min.css" />
|
|
//else -->
|
|
<link rel="stylesheet" type="text/css" href="/static/bwr/bootstrap/dist/css/bootstrap.css" />
|
|
<!-- //endif -->
|
|
<script type="text/javascript">/*<![CDATA[*/var NS='documentation:2.0';var JSINFO = {"id":"documentation:2.0:mail2f","namespace":"documentation:2.0"};
|
|
/*!]]>*/</script>
|
|
<script type="text/javascript" charset="utf-8" src="lib/exe/js.php.t.bootstrap3.js"></script>
|
|
<!-- //if:usedebianlibs
|
|
<script type="text/javascript" src="/javascript/jquery/jquery.min.js"></script>
|
|
//elsif:useexternallibs
|
|
<script type="text/javascript" src="http://code.jquery.com/jquery-2.2.0.min.js"></script>
|
|
//elsif:jsminified
|
|
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.min.js"></script>
|
|
//else -->
|
|
<script type="text/javascript" src="/static/bwr/jquery/dist/jquery.js"></script>
|
|
<!-- //endif -->
|
|
<!-- //if:usedebianlibs
|
|
<script type="text/javascript" src="/javascript/jquery-ui/jquery-ui.min.js"></script>
|
|
//elsif:useexternallibs
|
|
<script type="text/javascript" src="http://code.jquery.com/ui/1.10.4/jquery-ui.min.js"></script>
|
|
//elsif:jsminified
|
|
<script type="text/javascript" src="/static/bwr/jquery-ui/jquery-ui.min.js"></script>
|
|
//else -->
|
|
<script type="text/javascript" src="/static/bwr/jquery-ui/jquery-ui.js"></script>
|
|
<!-- //endif -->
|
|
</head>
|
|
<body>
|
|
<div class="dokuwiki export container">
|
|
|
|
<h1 class="sectionedit1" id="e-mail_as_second_factor">E-Mail as Second Factor</h1>
|
|
<div class="level1">
|
|
|
|
<p>
|
|
This plugin adds the user's e-mail account as a second authentication factor.
|
|
</p>
|
|
|
|
<p>
|
|
After logging in through another authentication module, a one-time code will be generated by the portal and sent to the user's e-mail address. The user will be prompted for this code in order to finish the login process.
|
|
</p>
|
|
<div class="noteimportant">This plugin will only improve security in situations where the user's email is not protected by the same password used to login on LemonLDAP::NG.
|
|
And of course, if the user's email account is also protected by LemonLDAP::NG, they will not be able to open their mailbox to find out their one-time code.
|
|
|
|
</div>
|
|
</div>
|
|
<!-- EDIT1 SECTION "E-Mail as Second Factor" [1-668] -->
|
|
<h3 class="sectionedit2" id="configuration">Configuration</h3>
|
|
<div class="level3">
|
|
|
|
<p>
|
|
Before configuring this module, make sure the user's email address is correctly fetched from your UserDB plugin and appears in the session browser. If you want to store the user e-mail in a different session field than <code>mail</code>, go to “General Parameters » Advanced parameters » SMTP” and set the “Session key containing mail address” parameter.
|
|
</p>
|
|
|
|
<p>
|
|
All parameters are configured in “General Parameters » Second factors » Mail second factor”.
|
|
</p>
|
|
<ul>
|
|
<li class="level1"><div class="li"> <strong>Activation</strong>: Set to <code>On</code> to activate this module. If a user does not have an email address, they will encounter an error on login. If you want to use this plugin only for users who have an email address, use <code>$mail</code> (or whatever your e-mail session key is) as the activation rule.</div>
|
|
</li>
|
|
<li class="level1"><div class="li"> <strong>Code regex</strong>: The regular expression used to generate one-time codes. The default is a 6-digit code.</div>
|
|
</li>
|
|
<li class="level1"><div class="li"> <strong>Code timeout</strong>: It might take a while for users to open their e-mail account and find the code. Raise this timeout if the default (2 minutes) isn't enough.</div>
|
|
</li>
|
|
<li class="level1"><div class="li"> <strong>Mail subject</strong>: The subject of the email the user will receive. If you leave it blank, it will be looked up in translation files.</div>
|
|
</li>
|
|
<li class="level1"><div class="li"> <strong>Mail body</strong>: The plain text content of the email the user will receive. If you leave it blank, the <code>mail_2fcode</code> <abbr title="HyperText Markup Language">HTML</abbr> template will be used. The one-time code is stored in the <code>$code</code> variable</div>
|
|
</li>
|
|
<li class="level1"><div class="li"> <strong>Authentication level</strong>: if you want to overwrite the value sent by your authentication module, you can define here the new authentication level. Example: 5</div>
|
|
</li>
|
|
<li class="level1"><div class="li"> <strong>Logo</strong> (Optional): logo file <em>(in static/<skin> directory)</em></div>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
<!-- EDIT2 SECTION "Configuration" [669-] --></div>
|
|
</body>
|
|
</html>
|