Update README.md

This commit is contained in:
Jakob Aarøe Dam 2015-04-29 09:38:43 +02:00
parent d6c918a7f1
commit 65117f24f8

View file

@ -3,8 +3,12 @@
Two-factor authentication for Remote Desktop Services (RDS). Two-factor authentication for Remote Desktop Services (RDS).
RDS Factor consist of two components: RDS Factor consist of two components:
* A server component that talks RADIUS with RD Web and the RD Gateway * A server component that talks RADIUS with RD Web and the RD Gateway.
* An updated version of the RD Web pages that interacts with the RADIUS server and ask users to enter one-time passwords sent to their phone before letting them in. * An updated version of the RD Web pages that interacts with the RADIUS server and an opt-in multi-factor form.
RDS Factor works by sending an SMS to users -- after they authenticate with username / password -- which when entered allow them entrance to RD Web. When users click on an applicaiton in RD Web a window is opened in the gateway for that user. In that way, users that are not authenticated via RD Web can't get access through RD Gateway. Compare this to the standard RDS setup, where there is no way to share state between RD Web and RD Gateway, meaning that the gateway is always open for user / password only authentication.
It is also possible to disable two factor authentication in RDS Factor. In this case, RDS Factor still maintains state between RD Web and RD Gateway, ensuring that users have logged into RD Web before connections are allowed through the gateway. That means custom multi-factor authenticators can be put in front of RD Web and also protect the gateway.
Tested on Windows 2012 R2. Tested on Windows 2012 R2.
@ -20,31 +24,30 @@ An RDS setup. There are many options for orchestrating the RDS setup; the minima
RDS factor comes with a customized version of the RD Web pages. To install these run: RDS factor comes with a customized version of the RD Web pages. To install these run:
``` ```
$ install-web.bat C:\RDSFactor> install-web.bat
``` ```
After install go and configure the application in IIS. RDWeb -> Pages -> Application Settings. You should configure the following settings: After install go and configure the application in IIS. `RDWeb -> Pages -> Application Settings`. You should configure the following settings:
* RadiusServer (IP of the radius server) * `RadiusServer` (IP of the radius server)
* RadiusSecret (Shared secret used for encryption of RADIUS traffic) * `RadiusSecret` (Shared secret -- of your own chosing -- used for encrypting RADIUS traffic)
### RADIUS server installation ### RADIUS server installation
The RADIUS server component can be installed on any server reacheable by both the RD Web and the RD Gateway. To install the server as a service run: The RADIUS server component can be installed on any server reacheable by both the RD Web and the RD Gateway. To install the server as a service run:
``` ```
$ install-server.bat C:\RDSFactor> install-server.bat
``` ```
After install go and configure the server. Open the file RDSFactor/server/bin/release/conf.ini for editing. You should configure the following settings: After install go and configure the server. Open the file `RDSFactor/server/bin/release/conf.ini` for editing. You should configure the following settings:
* LDAPDomain (IP of server to authenticate the user against and lookup phonenumber) * `LDAPDomain` IP of server to authenticate the user against and lookup phonenumber
* ADField (LDAP attribute to use for looking the user's phonenumber) * `ADField` LDAP attribute to use for looking the user's phonenumber
* {client}={shared secret} should be added in the clients section * `{client}={shared secret}` IP of RD Web and shared secret -- same as `RadiusSecret`-- for encryption
* `Provider` URL of SMS provider. RDS Factor inserts the number and a message in the two variable, `***NUMBER***` and `***TEXTMESSAGE***`, in the provider URL. An example URL using the SMS gateway cpsms: https://www.cpsms.dk/sms/?username=myuser&password=mypassword&recipient=***NUMBER***&message=***TEXTMESSAGE***&from=CPSMS
Note that the client should be the IP of RD Web, and the shared secret must match the value of RadiusSecret in the IIS.
To reload the configuration restart the RADIUS server service by running To reload the configuration restart the RADIUS server service by running
``` ```
$ restart-server.bat C:\RDSFactor> restart-server.bat
``` ```
## Acknowledgements ## Acknowledgements