Skip to content

DEV-416 new README #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tu-S wants to merge 1 commit into
base: master
Choose a base branch
from
Open

DEV-416 new README #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MultiFactor.SelfService.Windows.Portal.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,6 +523,7 @@
<Content Include="Content\js\jquery.validate.min.js" />
<Content Include="Content\js\jquery.validate.unobtrusive.js" />
<Content Include="Content\js\jquery.validate.unobtrusive.min.js" />
<Content Include="README.md" />
<Content Include="Views\Account\Authn.cshtml" />
<Content Include="Views\Account\Identity.cshtml" />
<Content Include="Web.config" />
Expand Down Expand Up @@ -703,7 +704,6 @@
</ItemGroup>
<ItemGroup>
<None Include="packages.config" />
<Content Include="README.md" />
<Content Include="Views\Account\ByPassSamlSession.cshtml" />
<Content Include="Views\Password\Change.cshtml" />
<Content Include="Views\Totp\Index.cshtml" />
Expand Down
115 changes: 11 additions & 104 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
![CodeQL](https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal/workflows/CodeQL/badge.svg)

# MultiFactor.SelfService.Windows.Portal
# Multifactor self-service windows portal

_Also available in other languages: [Русский](README.ru.md)_

MultiFactor SelfService Portal is a website developed and maintained by MultiFactor for self-enrollment of a second authentication factor by users within an Active Directory corporate network.
## What is Multifactor self-service windows portal?
MultiFactor SelfService Portal (Windows version) is a website developed and maintained by MultiFactor for self-enrollment of a second authentication factor by users within an Active Directory corporate network.

The portal is a part of <a href="https://multifactor.pro/" target="_blank">MultiFactor</a> 2FA hybrid solution.

* <a href="https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal" target="_blank">Source code</a>
* <a href="https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal/releases" target="_blank">Build</a>

See documentation at https://multifactor.pro/docs/multifactor-selfservice-windows-portal/ for additional guidance on Self-Service Portal deployment.
* <a href="https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal/releases" target="_blank">Releases</a>

## Table of Contents

- [Features](#features)
- [First Steps](#first-steps)
- [Prerequisites](#prerequisites)
- [Configuration](#configuration)
- [Installation](#installation)
- [Logs](#logs)
- [Access Portal](#access-portal)
- [What is Multifactor self-service windows portal?](#what-is-multiFactor-self-service-windows-portal)
- [Component Features](#component-features)
- [Use Cases](#use-cases)
- [Installation and configuration](#installation-and-configuration)
- [License](#license)

## Features
## Component Features

- User's login and password verification in an Active Directory domain. Multiple domains are supported if a trust relationship is configured between them;
- Configuration of the second authentication factor by the end-user;
Expand All @@ -34,94 +26,6 @@ See documentation at https://multifactor.pro/docs/multifactor-selfservice-window

The portal is designed to be installed and operated within the corporate network perimeter.

## First Steps

1. Navigate to your Multifactor <a href="https://multifactor.pro/login" target="_blank">personal profile</a> , and under the **Resources** section create a new website with the following paramteres:
- `Name and address:` `<could be any>`;
- `Token format:` `JwtRS256`.
2. Upon creation you should receive **ApiKey** and **ApiSecret** parameters. You will need these parameters to complete the installation.

## Prerequisites

- Installation requires Windows server starting from 2012 R2;
- The server with the installed portal requires access to the ```api.multifactor.ru``` host via TCP port 443 (TLS);
- You need to have a Web Server (IIS) role with Application Development -> ASP.NET 4.6 component installed on the server;

<img src="https://multifactor.pro/img/self-service-portal/windows-server-asp-net-role.png" width="600"/>

## Configuration

Portal settings are stored in the ```web.config``` file in XML format.

```xml
<portalSettings>
<!--Name of your organization-->
<add key="company-name" value="ACME" />
<!--Name of your Active Directory domain to verify username and password -->
<add key="company-domain" value="domain.local" />
<!--Company logo URL address-->
<add key="company-logo-url" value="/mfa/content/images/logo.svg" />

<!-- [Optional] Require second factor for users in specified group only (Single Sign-On users). Second-factor will be required for all users by default if setting is deleted. -->
<!--add key="active-directory-2fa-group" value="2FA Users"/-->

<!-- [Optional] Use your users' phone numbers contained in Active Directory to automatically enroll your users and start send one-time SMS codes. Option is not used if settings are removed. -->
<!--add key="use-active-directory-user-phone" value="true"/-->
<!--add key="use-active-directory-mobile-user-phone" value="true"/-->

<!-- Multifactor API Address-->
<add key="multifactor-api-url" value="https://api.multifactor.ru" />
<!-- API KEY parameter from the Multifactor personal account -->
<add key="multifactor-api-key" value="" />
<!-- API Secret parameter from the Multifactor personal account -->
<add key="multifactor-api-secret" value="" />

<!-- [Optional] Access the Multifactor API via the HTTP proxy -->
<!--add key="multifactor-api-proxy" value="http://proxy:3128"/-->

<!-- Logging level: 'Debug', 'Info', 'Warn', 'Error' -->
<add key="logging-level" value="Info" />

<!-- Enable captcha validation -->
<add key="enable-captcha" value="false"/>
<!-- Google/Yandex switch -->
<add key="captcha-type" value="Google"/>
<!-- Site Key from a captcha management panel -->
<add key="captcha-key" value="key"/>
<!-- Secret Key from a captcha management panel -->
<add key="captcha-secret" value="secret"/>
</portalSettings>
```

If the ```use-active-directory-user-phone``` option is enabled, the component will use the phone stored in the **General** tab. All phone number formats are supported.

<img src="https://multifactor.pro/img/radius-adapter/ra-ad-phone-source.png" width="400">

If the ```use-active-directory-mobile-user-phone``` option is enabled, the component will use the phone stored in the **Telephones** tab in the **Mobile** field. All phone number formats are supported.

<img src="https://multifactor.pro/img/radius-adapter/ra-ad-mobile-phone-source.png" width="400">

## Installation

1. Launch ```Server Manager``` -> ```Tools``` -> ```Internet Information Services (IIS) Manager```;

2. Right-click **Default Web Site** and select **Add Application**;
<img src="https://multifactor.pro/img/self-service-portal/windows-iis-add-app.png" width="600"/>

3. Create a new application:
* Alias: ```mfa```
* Physical path: ```path to the Self-Service Portal directory```

4. Save and close.

## Logs

The Self-Service Portal logs are located in the ```Logs``` directory. If they are not there, make sure that the directory is writable by the ```IIS AppPool\DefaultAppPool``` local user.

## Access Portal

The portal can be accessed at ```https://yourdomain.com/mfa```

## Use Cases

The portal is used for self-enrollment and registration of the second authentication factor by users within the corporate network. It also acts as a Single Sign-On entry point for corporate SSO applications.
Expand All @@ -131,6 +35,9 @@ Once the second-factor is configured, users can securely connect via VPN, VDI, o
- Two Factor Authentication [Windows VPN with Routing and Remote Access Service (RRAS)](https://multifactor.pro/docs/windows-2fa-rras-vpn/)
- Two-factor authentication for [Microsoft Remote Desktop Gateway](https://multifactor.pro/docs/windows-2fa-remote-desktop-gateway/)

## Installation and configuration
See [knowledge base](https://multifactor.pro/docs/multifactor-selfservice-windows-portal/) for information about configuration, launch and an additional guidance.

## License

MultiFactor SelfService Portal is distributed under the [MIT License](LICENSE.md).
Expand Down
113 changes: 12 additions & 101 deletions README.ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
![CodeQL](https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal/workflows/CodeQL/badge.svg)

# MultiFactor.SelfService.Windows.Portal
# Multifactor self-service windows portal

_Also available in other languages: [English](README.md)_

MultiFactor SelfService Portal &mdash; веб-сайт, портал самообслуживания, разработанный и поддерживаемый компанией Мультифактор для самостоятельной регистрации второго фактора аутентификации пользователями внутри корпоративной сети Active Directory.
## Что такое Multifactor self-service windows portal?
MultiFactor SelfService Portal (Windows версия) &mdash; веб-сайт, портал самообслуживания, разработанный и поддерживаемый компанией Мультифактор для самостоятельной регистрации второго фактора аутентификации пользователями внутри корпоративной сети Active Directory.

Портал самообслуживания является частью гибридного 2FA решения сервиса <a href="https://multifactor.ru/" target="_blank">MultiFactor</a>.

* <a href="https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal" target="_blank">Код</a>
* <a href="https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal/releases" target="_blank">Сборка</a>
* <a href="https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal" target="_blank">Исходный код</a>
* <a href="https://github.com/MultifactorLab/MultiFactor.SelfService.Windows.Portal/releases" target="_blank">Релизы</a>

## Содержание

## Содержание
- [Что такое Multifactor self-service windows portal?](#что-такое-multifactor-self-service-windows-portal?)
- [Функции портала](#функции-портала)
- [Первые шаги](#первые-шаги)
- [Требования для установки портала](#требования-для-установки-портала)
- [Конфигурация портала](#конфигурация-портала)
- [Установка портала](#установка-портала)
- [Журналы](#журналы)
- [Доступ к порталу](#доступ-к-порталу)
- [Сценарии использования](#сценарии-использования)
- [Установка и конфигурация](#установка-и-конфигурация)
- [Лицензия](#лицензия)

## Функции портала
Expand All @@ -32,94 +28,6 @@ MultiFactor SelfService Portal &mdash; веб-сайт, портал самоо

Портал предназначен для установки и работы внутри корпоративной сети.

## Первые шаги

1. Зайдите в <a href="https://multifactor.ru/login" target="_blank">личный кабинет</a> Мультифактора, в разделе **Ресурсы** создайте новый веб-сайт:
- название и адрес: ``произвольные``;
- формат токена: ``JwtRS256``.
2. После создания вам будут доступны параметры **ApiKey** и **ApiSecret**, они потребуются для настройки портала.

## Требования для установки портала

- Портал устанавливается на любой Windows сервер начиная с версии 2012 R2;
- Серверу с установленным порталом необходим доступ к хосту ```api.multifactor.ru``` по TCP порту 443 (TLS).
- На сервере должна быть установлена роль Web Server (IIS) с компонентом Application Development -> ASP.NET 4.6;

<img src="https://multifactor.ru/img/self-service-portal/windows-server-asp-net-role.png" width="600"/>

## Конфигурация портала

Параметры работы портала хранятся в файле ```web.config``` в формате XML.

```xml
<portalSettings>
<!--Название вашей организации-->
<add key="company-name" value="ACME" />
<!--Название домена Active Directory для проверки логина и пароля пользователей -->
<add key="company-domain" value="domain.local" />
<!--URL адрес логотипа организации -->
<add key="company-logo-url" value="/mfa/content/images/logo.svg" />

<!--Запрашивать второй фактор только у пользователей из указанной группы для Single Sign On (второй фактор требуется всем, если удалить настройку)-->
<!--add key="active-directory-2fa-group" value="2FA Users"/-->

<!--Использовать номер телефона из Active Directory для отправки одноразового кода в СМС (не используется, если удалить настройку)-->
<!--add key="use-active-directory-user-phone" value="true"/-->
<!--add key="use-active-directory-mobile-user-phone" value="true"/-->

<!--Адрес API Мультифактора -->
<add key="multifactor-api-url" value="https://api.multifactor.ru" />
<!-- Параметр API KEY из личного кабинета Мультифактора -->
<add key="multifactor-api-key" value="" />
<!-- Параметр API Secret из личного кабинета Мультифактора -->
<add key="multifactor-api-secret" value="" />

<!--Доступ к API Мультифактора через HTTP прокси (опционально)-->
<!--add key="multifactor-api-proxy" value="http://proxy:3128"/-->

<!-- Уровень логирования: 'Debug', 'Info', 'Warn', 'Error' -->
<add key="logging-level" value="Info" />

<!-- Enable captcha validation -->
<add key="enable-captcha" value="false"/>
<!-- Google/Yandex switch -->
<add key="captcha-type" value="Google"/>
<!-- Site Key from a captcha management panel -->
<add key="captcha-key" value="key"/>
<!-- Secret Key from a captcha management panel -->
<add key="captcha-secret" value="secret"/>
</portalSettings>
```

При включении параметра ```use-active-directory-user-phone``` компонент будет использовать телефон, записанный на вкладке **General**. Формат телефона может быть любым.

<img src="https://multifactor.ru/img/radius-adapter/ra-ad-phone-source.png" width="400px">

При включении параметра ```use-active-directory-mobile-user-phone``` компонент будет использовать телефон, записанный на вкладке **Telephones** в поле **Mobile**. Формат телефона также может быть любым.

<img src="https://multifactor.ru/img/radius-adapter/ra-ad-mobile-phone-source.png" width="400">

## Установка портала

1. Запустите ```Server Manager``` -> ```Tools``` -> ```Internet Information Services (IIS) Manager```;

2. Нажмите правой кнопкой на **Default Web Site** и выберите **Add Application**;
<img src="https://multifactor.ru/img/self-service-portal/windows-iis-add-app.png" width="400"/>

3. Создайте новое приложение:
* Alias: ```mfa```
* Physical path: ```путь к папке с порталом```

4. Сохраните и закройте

## Журналы

Журналы работы портала находятся в папке ```Logs```. Если их нет, удостоверьтесь, что папка доступна для записи локальному пользователю ```IIS AppPool\DefaultAppPool```.

## Доступ к порталу

Портал доступен по адресу ```https://ваш_домен.ru/mfa```

## Сценарии использования

Портал используется для самостоятельной регистрации второго фактора аутентификации пользователями внутри корпоративной сети, а также выполняет роль единой точки входа для приложений, работающих по технологии Single Sign-On.
Expand All @@ -130,6 +38,9 @@ MultiFactor SelfService Portal &mdash; веб-сайт, портал самоо
- Двухфакторная аутентификация [Windows VPN со службой Routing and Remote Access Service (RRAS)](https://multifactor.ru/docs/windows-2fa-rras-vpn/)
- Двухфакторная аутентификация [Microsoft Remote Desktop Gateway](https://multifactor.ru/docs/windows-2fa-remote-desktop-gateway/)

## Установка и конфигурация
Информацию о настройке, запуске и дополнительные рекомендации смотрите в [документации](https://multifactor.ru/docs/self-service-portal/windows).

## Лицензия

Портал распространяется бесплатно по лицензии [MIT](LICENSE.md).
Портал распространяется бесплатно по лицензии [MIT](LICENSE.md).