Project

Profile

Help

Download (2.34 KB) Statistics
| Branch: | Revision:

root / README.md @ master

1 65b0b24a Felix Schäfer
Redmine email 2-factor authentication
2
=====================================
3
4
This plugin adds a 2-factor authentication email scheme to Redmine in the
5
style proposed in the patches for [Redmine issue 1237](https://www.redmine.org/issues/1237).
6
7
Each time a one-time-password is required in Redmine, an email is sent to the
8
user with a one-time-password/code and a link the user can click instead of
9
copying and pasting the one-time-password into Redmine.
10
11
12
Security considerations
13
-----------------------
14
15
Please note that this scheme uses the user's email address to deliver the
16
one-time-password and thus offers less security than a "real" second channel,
17
for example SMS, or another one-time-password scheme such as time-based
18
one-time-passwords (TOTP).
19
20
Administrators should thouroughly check if this scheme offers the security
21
improvement they require before using this plugin.
22
23
The main purpose of this plugin is to demonstrate how the proposed Redmine
24
2-factor functionality can be extended by plugins in order to offer more
25
channels than just the TOTP as proposed in the patches. Due to the security
26
considerations above, it should probably not be used in production in most
27
scenarios.
28
29
30
Installation
31
------------
32
33
This plugin requires the patches for [Redmine issue 1237](https://www.redmine.org/issues/1237).
34
35
[Standard Redmine plugin installation instructions](https://redmine.org/projects/redmine/wiki/Plugins#Installing-a-plugin)
36
apply.
37
38
39
Usage
40
-----
41
42
Just install the plugin as described above, as long as the plugin is installed
43
the email scheme will be available for 2-factor authentication in your
44
Redmine.
45
46
47
Author & License
48
----------------
49
50
Created by Felix Schäfer for [Planio GmbH](https://plan.io)
51
52
The Redmine email 2-factor authentication plugin is free software; you can
53
redistribute it and/or modify it under the terms of the GNU General Public
54
License as published by the Free Software Foundation; either version 2 of the
55
License, or (at your option) any later version.
56
57
This program is distributed in the hope that it will be useful, but WITHOUT
58
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
59
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
60
details.
61
62
You should have received a copy of the GNU General Public License along with
63
the plugin. If not, see [www.gnu.org/licenses](https://www.gnu.org/licenses/).