In-Portal Developers Guide

This is a wiki-based Developers Guide for In-Portal Open Source CMS. The purpose of this guide is to provide advanced users, web developers and programmers with documentation on how to expand, customize and improve the functionality and the code the In-Portal software. Please consider contributing to our documentation writing effort.

K4:Enabling SSL

From In-Portal Developers Guide

(Difference between revisions)
Jump to: navigation, search
m (1 версия)
Line 1: Line 1:
{{toc | category = Настройка системы | sortkey = 003.001}}
{{toc | category = Настройка системы | sortkey = 003.001}}
Перед настройкой протокола нужно, что бы на сервере был установлен действительный (valid) SSL-сертификат.
Перед настройкой протокола нужно, что бы на сервере был установлен действительный (valid) SSL-сертификат.
 +
Before configuring the protocol, a valid SSL-certificate must be installed on the server.
{| class="prettytable vertical-table"
{| class="prettytable vertical-table"
-
! действительный SSL-сертификат || не действительный SSL-сертификат
+
! valid SSL-certificate || invalid SSL-certificate
|-
|-
| style="text-align: center;" | [[Image:ssl_valid.jpg|frameless|border|действительный SSL-сертификат]]
| style="text-align: center;" | [[Image:ssl_valid.jpg|frameless|border|действительный SSL-сертификат]]
| style="text-align: center;" | [[Image:ssl_error.jpg|frameless|border|не действительный SSL-сертификат]]
| style="text-align: center;" | [[Image:ssl_error.jpg|frameless|border|не действительный SSL-сертификат]]
|}
|}
-
В приведённой выше таблице можно увидеть как выгладит окно браузера, в случает когда установлен действительный SSL-сертификат и в случае, когда SSL-сертификат не действителен (напр. выдан другому сайту).
+
The above example shows how a browser window looks when a valid SSL-certificate is installed versus when an invalid SSL-certificate is installed (for example, because it was issued to a different site).
-
== Общие положения ==
+
== Общие положения - General Items?? ==
-
Все требуемые для настройки [[K4:Configuration|конфигурационные переменные]] находятся в разделе "<code>Configuration -> System Variables</code>" административной консоли сайта. Независимо о того для какой части сайта настраивается SSL всегда требуется указать значение конфигурационной переменной [[K4:Configuration#SSL_URL|SSL_URL]] ("<code><nowiki>SSL Full URL (https://www.domain.com/path)</nowiki></code>").
+
All [[K4:Configuration|configuration variables]] needed for configuring an SSL can be found in the section "<code>Configuration -> System Variables</code>" in the administrative console. It doesn't matter for which side of the site the SSL is being setup, a value for the configuration variable [[K4:Configuration#SSL_URL|SSL_URL]] ("<code><nowiki>SSL Full URL (https://www.domain.com/path)</nowiki></code>") must always be entered.
-
== SSL для административной консоли ==
+
 
-
[[Image:ssl_admin.jpg|thumb|left|Административная консоль в режиме SSL]]
+
== SSL for the administrative console ==
-
Для подключения SSL к административной консоли требуется включить конфигурационную переменную [[K4:Configuration#Require_AdminSSL|Require_AdminSSL]] ("<code>Require SSL for Administrative Console</code>"). Далее нажимаем кнопку <code>Save</code> на панели инструментов и выходим из системы (<code>logout</code>). На странице ввода имени пользователя и пароля должны увидеть то, что обведено на приведённом слева изображении. Вот и все – протокол успешно настроен для административной консоли.{{clear|left}}
+
[[Image:ssl_admin.jpg|thumb|left|Administrative console in SSL mode]]
 +
To configure an SSL for the administrative console, the configuration variable [[K4:Configuration#Require_AdminSSL|Require_AdminSSL]] ("<code>Require SSL for Administrative Console</code>") must be turned on. Then, we press the <code>Save</code> button in the toolbar and exit the system (<code>logout</code>). On the login page, you should see what's circled on the image to the left. That's it - the protocol has been configured successfully for the administrative console. {{clear|left}}
== SSL для пользовательской части сайта ==
== SSL для пользовательской части сайта ==

Revision as of 03:32, 24 March 2009

Настройка системы Настройка системы
Статьи в этой категории

Перед настройкой протокола нужно, что бы на сервере был установлен действительный (valid) SSL-сертификат. Before configuring the protocol, a valid SSL-certificate must be installed on the server.

valid SSL-certificate invalid SSL-certificate
действительный SSL-сертификат не действительный SSL-сертификат

The above example shows how a browser window looks when a valid SSL-certificate is installed versus when an invalid SSL-certificate is installed (for example, because it was issued to a different site).

Общие положения - General Items??

All configuration variables needed for configuring an SSL can be found in the section "Configuration -> System Variables" in the administrative console. It doesn't matter for which side of the site the SSL is being setup, a value for the configuration variable SSL_URL ("SSL Full URL (https://www.domain.com/path)") must always be entered.


SSL for the administrative console

Administrative console in SSL mode
Administrative console in SSL mode

To configure an SSL for the administrative console, the configuration variable Require_AdminSSL ("Require SSL for Administrative Console") must be turned on. Then, we press the Save button in the toolbar and exit the system (logout). On the login page, you should see what's circled on the image to the left. That's it - the protocol has been configured successfully for the administrative console.

SSL для пользовательской части сайта

Для подключения SSL к пользовательской части сайта требуется включить некоторые (в зависимости от функциональности настраиваемого сайта) из ниже приведённых конфигурационных переменных:

конфигурационная переменная описание
Require_SSL
Require SSL for login & checkout 		Включение SSL режима для страниц сайта, где в html коде шаблона прописан тег <inp2:m_CheckSSL mode="required" condition="Require_SSL"/>
Force_HTTP_When_SSL_Not_Required
Redirect to HTTP when SSL is not required 		Эта опция нужна для того, чтобы при переходе со страницы с включенным SSL протоколом на страницу без SSL, происходил автоматический переход на адрес без https.
UseModRewriteWithSSL
Enable MOD_REWRITE for SSL 		Если пользовательская часть сайта использует технологию MOD_REWRITE, то можно (но не обязательно) включить данную опцию, для того, чтобы в SSL-режиме тоже строились MOD_REWRITE ссылки.

Для перехода в SSL-режим и обратно на шаблонах следует использовать тэг m_CheckSSL. Его рекомендуется ставить в начале шаблона или после тэга m_RequireLogin, когда таковой используется. Ниже приведён пример использования данного тега в шаблоне: 

<inp2:m_CheckSSL mode="required"/>
<inp2:m_include template="inc/header"/> // внутри шаблона "inc/header" должен быть тэг <inp2:m_CheckSSL/>
HTML Code
<inp2:m_include template="inc/footer"/>

Описание параметров тега m_CheckSSL:

название описание
mode (string) Если указать "required" в качестве значения данного параметра, то шаблон будет помечен, как требующий наличия SSL-режима для своей корректной работы. Если потом зайти на этот шаблон не из SSL-режима, то будет автоматически включён SSL-режим. Если параметр не указывать или указать пустое значение, то произойдёт обратное действие.
for_logged_in_only (int) Если указать данный параметр, то SSL-режим будет включаться только для авторизованных пользователей.
condition (string) Название конфигурационной переменной, значение которой нужно проверить перед тем, как разрешать переход в SSL-режим. Если указанная конфигурационная переменная отсутствует или выключена, то переход в SSL-режим осуществлён не будет.
Image:Tipbox Icon.gif Для пользовательской части сайта можно использовать конфигурационную переменную Require_SSL.
Если планируется переключать некоторые части сайта в SSL-режим в зависимости от настроек конфигурации, то этот параметр является тем, что нужно.
Профиль пользователя в режиме SSL
Профиль пользователя в режиме SSL

Вот в принципе и все, после включения всех соответствующих опций и установки тэга m_CheckSSL можно считать настройку законченной. На приведённом слева изображении показана страница My Account, со включенным протоколом SSL. На ней также можно отчётливо видеть 2 корректных "SSL замочка", которые свидетельствуют о том, что защищённый режим установлен правильно. Если же эти "замочки" показаны с перечёркнутой линией, то это означает, что протокол не корректно установлен на сервере или время его действия истекло.

Предупреждение SSL сертификата
Предупреждение SSL сертификата
 Возможна ситуация, когда браузер может, при попадании на страницу, показывать приведённое на изображении слева сообщение об ошибке. Как правило, такое сообщение можно увидеть тогда, когда на странице есть ссылка, которая прописана не через относительный путь, а через абсолютный и без указания факта использования протокола SSL. Чтобы этого избежать настоятельно рекомендуется все ссылки на элементы сайта (изображения, таблицы стилей и т.п.) формировать при помощи тэга m_TemplatesBase:
  • не правильно: <img src="http://www.youdomain.com/img/sample_image.gif" alt=""/>
  • правильно: <img src="<inp2:m_TemplatesBase/>/img/sample_image.gif" alt=""/>
Retrieved from "http://guide.in-portal.org/eng/index.php/K4:Enabling_SSL"