nopCommerce Dokumentace

Nastavení v souboru web.config

Co je soubor web.config

Soubor web.config je konfigurační soubor založený na XML, který se v aplikacích postavených na ASP.NET používá ke správě různých nastavení týkajících se konfigurace webu. Díky tomu můžeme oddělit aplikační logiku od konfigurační logiky. Hlavní výhodou je, že pokud chceme změnit některá konfigurační nastavení, nemusíme aplikaci restartovat, aby se nové změny projevily – ASP.NET změny automaticky rozpozná a použije je na běžící aplikaci ASP.NET.

Framework ASP.NET používá hierarchický systém konfigurace. Soubor web.config můžete umístit do libovolného podadresáře aplikace. Soubor se pak vztahuje na všechny stránky umístěné ve stejném adresáři nebo v jeho podadresářích.

web.config v nopCommerce

nopCommerce používá soubor web.config v projektu Nop.Web, který najdete v adresáři Presentation. V kořenovém adresáři projektu uvidíte soubor web.config. Pokud je vaše řešení čerstvou instalací nopCommerce, obsah tohoto souboru vypadá přibližně takto:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <system.webServer>
    <modules>
        <!-- Remove WebDAV module so that we can make DELETE requests -->
        <remove name="WebDAVModule" />
    </modules>
    <handlers>
        <!-- Remove WebDAV module so that we can make DELETE requests -->
        <remove name="WebDAV" />
        <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" resourceType="Unspecified" />
    </handlers>
    <!-- When deploying on Azure, make sure that "dotnet" is installed and the path to it is registered in the PATH environment variable or specify the full path to it -->
    <aspNetCore requestTimeout="23:00:00" processPath="%LAUNCHER_PATH%" arguments="%LAUNCHER_ARGS%" forwardWindowsAuthToken="false" stdoutLogEnabled="false" stdoutLogFile=".\logs\stdout" startupTimeLimit="3600" hostingModel="InProcess">
    </aspNetCore>
    <httpProtocol>
        <customHeaders>
        <remove name="X-Powered-By" />
        <!-- Protects against XSS injections. ref.: https://www.veracode.com/blog/2014/03/guidelines-for-setting-security-headers/ -->
        <add name="X-XSS-Protection" value="1; mode=block" />
        <!-- Protects against Clickjacking attacks. ref.: http://stackoverflow.com/a/22105445/1233379 -->
        <add name="X-Frame-Options" value="SAMEORIGIN" />
        <!-- Protects against MIME-type confusion attack. ref.: https://www.veracode.com/blog/2014/03/guidelines-for-setting-security-headers/ -->
        <add name="X-Content-Type-Options" value="nosniff" />
        <!-- Protects against Clickjacking attacks. ref.: https://www.owasp.org/index.php/HTTP_Strict_Transport_Security_Cheat_Sheet -->
        <add name="Strict-Transport-Security" value="max-age=31536000; includeSubDomains" />
        <!-- CSP modern XSS directive-based defence, used since 2014. ref.: http://content-security-policy.com/ -->
        <add name="Content-Security-Policy" value="default-src 'self'; connect-src *; font-src * data:; frame-src *; img-src * data:; media-src *; object-src *; script-src * 'unsafe-inline' 'unsafe-eval'; style-src * 'unsafe-inline';" />
        <!-- Prevents from leaking referrer data over insecure connections. ref.: https://scotthelme.co.uk/a-new-security-header-referrer-policy/ -->
        <add name="Referrer-Policy" value="same-origin" />
        <!-- Permissions-Policy is a new header that allows a site to control which features and APIs can be used in the browser. ref.: https://w3c.github.io/webappsec-permissions-policy/ -->
        <add name="Permissions-Policy" value="accelerometer=(), camera=(), geolocation=(), gyroscope=(), magnetometer=(), microphone=(), payment=*, usb=()" />
      </customHeaders>
    </httpProtocol>
    </system.webServer>
</configuration>
<configuration>
    ...
</configuration>

Každé konfigurační pravidlo se zapisuje do elementu „<configuration>“.

<system.webServer>
    ...
</system.webServer>

Element <system.webServer> je kořenovým elementem pro mnoho konfiguračních nastavení IIS na úrovni webu a aplikace a obsahuje konfigurační elementy, které definují nastavení používaná jádrem webového serveru a moduly.

<modules>
    <!-- Remove WebDAV module so that we can make DELETE requests -->
    <remove name="WebDAVModule" />
</modules>

Element <modules> definuje moduly v nativním kódu a moduly ve spravovaném kódu, které jsou pro aplikaci registrovány. Moduly běžně používáme k implementaci vlastní funkcionality.

Element <modules> obsahuje kolekci elementů <add>, <remove> a <clear>.

nopCommerce zde používá element <remove> k odebrání modulu WebDAVModule z aplikace.

<handlers>
    <!-- Remove WebDAV module so that we can make DELETE requests -->
    <remove name="WebDAV" />
    <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" resourceType="Unspecified" />
</handlers>

Obslužné rutiny (handlers) jsou komponenty IIS nakonfigurované ke zpracování požadavků na konkrétní obsah, obvykle za účelem vygenerování odpovědi pro požadovaný prostředek. Například webová stránka ASP.NET je jedním typem obslužné rutiny. Obslužné rutiny můžete použít ke zpracování požadavků na jakýkoli prostředek, který má uživatelům vracet informace a není statickým souborem.

Element <handlers> obsahuje kolekci elementů <add>, <remove> a <clear>, z nichž každý definuje mapování obslužné rutiny pro aplikaci. Element <add> přidá obslužnou rutinu do kolekce obslužných rutin, element <remove> odebere odkazy na obslužnou rutinu z kolekce a element <clear> odebere z kolekce všechny odkazy na obslužné rutiny. Ve výše uvedeném kódu je odebrána obslužná rutina „WebDAV“ a přidána obslužná rutina pro modul AspNetCoreModuleV2.

<aspNetCore requestTimeout="23:00:00" processPath="%LAUNCHER_PATH%" arguments="%LAUNCHER_ARGS%" forwardWindowsAuthToken="false" stdoutLogEnabled="false" stdoutLogFile=".\logs\stdout" startupTimeLimit="3600" hostingModel="InProcess"/>
<httpProtocol>
        <customHeaders>
        <remove name="X-Powered-By" />
        <!-- Protects against XSS injections. ref.: https://www.veracode.com/blog/2014/03/guidelines-for-setting-security-headers/ -->
        <add name="X-XSS-Protection" value="1; mode=block" />
        <!-- Protects against Clickjacking attacks. ref.: http://stackoverflow.com/a/22105445/1233379 -->
        <add name="X-Frame-Options" value="SAMEORIGIN" />
        <!-- Protects against MIME-type confusion attack. ref.: https://www.veracode.com/blog/2014/03/guidelines-for-setting-security-headers/ -->
        <add name="X-Content-Type-Options" value="nosniff" />
        <!-- Protects against Clickjacking attacks. ref.: https://www.owasp.org/index.php/HTTP_Strict_Transport_Security_Cheat_Sheet -->
        <add name="Strict-Transport-Security" value="max-age=31536000; includeSubDomains" />
        <!-- CSP modern XSS directive-based defence, used since 2014. ref.: http://content-security-policy.com/ -->
        <add name="Content-Security-Policy" value="default-src 'self'; connect-src *; font-src * data:; frame-src *; img-src * data:; media-src *; object-src *; script-src * 'unsafe-inline' 'unsafe-eval'; style-src * 'unsafe-inline';" />
        <!-- Prevents from leaking referrer data over insecure connections. ref.: https://scotthelme.co.uk/a-new-security-header-referrer-policy/ -->
        <add name="Referrer-Policy" value="same-origin" />
        <!-- Permissions-Policy is a new header that allows a site to control which features and APIs can be used in the browser. ref.: https://w3c.github.io/webappsec-permissions-policy/ -->
        <add name="Permissions-Policy" value="accelerometer=(), camera=(), geolocation=(), gyroscope=(), magnetometer=(), microphone=(), payment=*, usb=()" />
      </customHeaders>
    </httpProtocol>

Element <customHeaders> elementu <httpProtocol> určuje vlastní hlavičky HTTP, které IIS vrátí v odpovědích HTTP z webového serveru.

Hlavičky HTTP jsou dvojice názvů a hodnot, které se vracejí v odpovědích webového serveru. Vlastní hlavičky odpovědi se odesílají klientovi spolu s výchozí hlavičkou HTTP. Na rozdíl od hlaviček odpovědi pro přesměrování, které se vracejí pouze v případě přesměrování, se vlastní hlavičky odpovědi vracejí v každé odpovědi.

Konfigurace pravidel přesměrování v IIS

K výše uvedeným konfiguracím můžeme přidat další. Zde si ukážeme, jak nakonfigurovat pravidla přesměrování v IIS.

Pravidlo přesměrování umožňuje, aby na jednu webovou stránku odkazovalo více URL. Důvodů, proč chcete přesměrovat požadavek z jednoho serveru na jiný, může být několik. Například se mohl změnit název vaší společnosti a vy chcete zaregistrovat novou doménu a přesunout na ni svůj web; v takovém případě budete chtít přesměrovat všechny požadavky ze staré domény na novou.

Aby mohl náš web používat pravidla přesměrování, musíme nainstalovat modul „URL rewrite“, což je rozšíření IIS.

Pro účely ukázky předpokládejme, že musíme přesměrovat požadavek ze starého webu na nový. K tomu musíme do souboru web.config zapsat následující pravidla.

<rewrite>
  <rules>
     <rule name="[RULE NAME]" stopProcessing="true">
     <match url="(.*)" />
     <conditions logicalGrouping="MatchAny" trackAllCaptures="false">
        <add input="{HTTP_HOST}{REQUEST_URI}" pattern="[OLD URL]" />
     </conditions>
     <action type="Redirect" url="http://[NEW URL]/{R:1}" redirectType="Permanent"/>
     </rule>
  </rules>
</rewrite>

Poznámka

Pomocí tohoto pravidla můžeme přesměrovat všechny stránky starého doménového jména na stejnou stránku na novém doménovém jménu.

Zde musíme nahradit [RULE NAME], [OLD URL] a [NEW URL] příslušnými údaji.

  • [RULE NAME] může být cokoli, co popisuje, co toto pravidlo dělá
  • [OLD URL] je stará URL, ze které chcete přesměrovat.
  • [NEW URL] je nová URL, na kterou chcete přesměrovat.
<match url="(.*)" />

Výše uvedený element říká, že toto pravidlo bude odpovídat všem řetězcům URL.

<add input="{HTTP_HOST}{REQUEST_URI}" pattern="[OLD URL]" />

Výše uvedený element přidává k pravidlu podmínku, která načte hodnotu hostitele a URI požadavku ze serverových proměnných HTTP_HOST a REQUEST_URI a porovná ji se vzorem s hodnotou zadanou pro [OLD URL].

<action type="Redirect" url="http://[NEW URL]/{R:1}" redirectType="Permanent"/>

Tento element přesměruje odpovídající starou URL na novou URL.