147
edits
Changes
From SME Server
Jump to navigationJump to searchConsolidated template creation instructions to their own section, removed example numbers (auto-number on the headings takes care of it)
= htaccess configuration using custom templates =
== Problem ==
'''.htaccess files are disabled by default''' on SME Server, and should not be enabled unless there is a need for users to independently change web access controls.
A system administrator wants to implement custom restrictions or directives for a web-accessible directory on a SME Server, but as '''.htaccess files are disabled by default''' on SME Server, and the enabling of them is not generally recommended, then another method is required.
These restrictions or access controls may include limiting access to a specified range of IP addresses, enabling the Apache rewrite engine (and specifying rewrite rules), requiring a password to access a subdirectory of an ibay, and numerous other possibilities.
== Solution ==
The recommended way to implement custom access controls or web server directives on an SME server is to add those controls to the main web server configuration file using custom template fragments. This method allows the system administrator to keep control of the web server security settings, and ensures that other system users will not inadvertently (or deliberately) compromise the web server's security.
The recommended way to implement custom access controls or web server directives on an SME server is to add those controls to the main web server configuration file using custom template fragments. This method allows the system administrator to keep control of the web server security settings, and ensures that other system users will not inadvertently (or deliberately) compromise the web server's security.
The [http://httpd.apache.org/docs/current/howto/htaccess.html Apache web server documentation] recommends avoiding use of .htaccess files when possible, for both performance and security reasons.
The [http://httpd.apache.org/docs/current/howto/htaccess.html Apache web server documentation] recommends avoiding use of .htaccess files when possible, for both performance and security reasons.
Various examples are shown in this article, which include how to implement secure authorised access to folders/subfolders in your SME Server ibays. The default settings in SME Server allow you to secure the ibays using the Information Bay panel in server manager, by creating an ibay password which is used to allow authorised access to the ibay from the Internet, but this does not control access to individual folders.
Various examples are shown in this article, which include basic redirection & rewrite, and how to implement secure authorised access to folders/subfolders in SME Server ibays using different auth methods.
A default SME Server server manager panel allows ibay access from the Internet to be secured with a password, (see Information Bay panel). This only controls access to the main ibay folder & does not control access to individual folders or subfolders, so the auth examples given, can allow further control possibilities beyond the default settings available in SME server.
{{Note box|These are specific examples only, & the custom template method can be configured for any directives, as required by the sysadmin.}}
==Using custom templates to configure htaccess requirements==
=== Determining contents of template fragment ===
A .htaccess file implements web server directives for the directory in which it is placed, and any subdirectory. Those directives can also be placed in the main web server configuration file, which is the method described on this page. Due to the way SME server uses [[Template Tutorial|templates]] for configuration files, we will create a small template file (a "template fragment") incorporating our desired changes, rather than directly editing the main configuration file. For this method to work, however, the directory to which those directives apply must be explicitly specified.
A template fragment intended to replace a .htaccess file will include a Directory tag, the server directives, and a /Directory tag. It will look like this:
<Directory /home/e-smith/files/ibays/youribayname/html>
(any server directives that are appropriate)
</Directory>
Initially you will need to determine the contents of your .htacess file to be used in the fragment. Refer to the .htaccess web site links below for more details.
Initially you will need to determine the contents of your .htacess file to be used in the fragment. Refer to the .htaccess web site links below for more details.
{{Warning box|Please choose your AuthUserFile password file name carefully so that it does not correspond with existing filenames. Do not name the file passwd as that filename already exists, and you will overwrite the original system file and make your server inaccessible. Choose a meaningful name like ibaypasswords or similar.}}
{{Warning box|Please choose your AuthUserFile password file name carefully so that it does not correspond with existing filenames. Do not name the file passwd as that filename already exists, and you will overwrite the original system file and make your server inaccessible. Choose a meaningful name like ibaypasswords or similar.}}
===Examples===
===Creating the template fragment===
For any of the examples below, you will create one or more custom template fragments, edit them to meet your requirements, expand the httpd.conf file, and restart the web server. Take the following steps:
First, create the directory for your template fragments, if it doesn't already exist:
[root@e-smith ~]# '''mkdir -p /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf'''
The -p flag will create any intermediate directories, if they don't already exist. If this directory already exists, the command will return without an error.
Then, change to the template directory and create a new template fragment, with the name of your choice:
[root@e-smith ~]# '''cd /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf'''
[root@e-smith httpd.conf]# '''nano -w 50AddSecureIbayFolder'''
...
Edit the file to include the text from one of the examples below, or any other directives that are appropriate for your installation. The -w flag to nano disables word wrap, so nano will not insert line breaks on long lines. Once you are finished editing the file, press Ctrl-X to exit, and Y to save. Then
[root@e-smith httpd.conf]# '''expand-template /etc/httpd/conf/httpd.conf'''
[root@e-smith httpd.conf]# '''service httpd-e-smith restart'''
Your web server is now restarted with your custom settings in place. You should test them to ensure the function as intended.
===Examples===
====Basic layout of fragment for a redirect rewrite directive====
Create a custom httpd.conf template fragment that looks like this (replace with appropriate details)
<Directory /home/e-smith/files/ibays/youribay/html>
Options +FollowSymLinks
RewriteEngine On
RewriteCond %{QUERY_STRING} base64_encode[^(]*\([^)]*\) [OR]
RewriteCond %{QUERY_STRING} (<|%3C)([^s]*s)+cript.*(>|%3E) [NC,OR]
...
</Directory>
====Authentication against a user password file====
Using the htaccess file contents example from above, and assuming we want to secure an ibay subfolder called
Using the htaccess file contents example from above, and assuming we want to secure an ibay subfolder called
</Limit>
</Limit>
</Directory>
</Directory>
{{Note box|msg= in according with [[bugzilla:7871]] and [[bugzilla:7890]] the following apache modules are loaded by default in the SME8 and also in the future release of SME9.
{{Note box|msg= in according with [[bugzilla:7871]] and [[bugzilla:7890]] the following apache modules are loaded by default in the SME8 and also in the future release of SME9.
there is no longer the requirement to add these by using a custom template 20LoadModule55}}
there is no longer the requirement to add these by using a custom template 20LoadModule55}}
===== Password file creation =====
=====Password file creation=====
Now you need to create the password file, change to the location you want the password file in
Now you need to create the password file, change to the location you want the password file in
If you use the -c switch when entering additional user details you will overwrite the password file completely and only have the one user entry there.
If you use the -c switch when entering additional user details you will overwrite the password file completely and only have the one user entry there.
==== Example 3 - authentication against all sme users ====
====Authentication against all sme users====
Determine the contents of your .htacess file to be used in the fragment, as mentioned previously.
Determine the contents of your .htacess file to be used in the fragment, as mentioned previously.
The contents shown below will suffice for standard situations.
The contents shown below will suffice for standard situations.
Assuming we want to secure an ibay subfolder called
Assuming we want to secure an ibay subfolder called
there is no longer the requirement to add these by using a custom template 20LoadModule55}}
there is no longer the requirement to add these by using a custom template 20LoadModule55}}
==== Example 4 - authentication against specified sme users ====
====Authentication against specified sme users====
Determine the contents of your .htacess file to be used in the fragment, as mentioned previously.
Determine the contents of your .htacess file to be used in the fragment, as mentioned previously.
The contents shown below will suffice for standard situations.
The contents shown below will suffice for standard situations.
Assuming we want to secure an ibay subfolder called
Assuming we want to secure an ibay subfolder called
there is no longer the requirement to add these by using a custom template 20LoadModule55}}
there is no longer the requirement to add these by using a custom template 20LoadModule55}}
==== Example 4 - authentication against groups ====
====Authentication against groups====
* Unixgroup
* Unixgroup
http://forums.contribs.org/index.php/topic,38959.msg177967.html#msg177967
http://forums.contribs.org/index.php/topic,38959.msg177967.html#msg177967
=== Testing ===
===Testing===
Now you can test the web site access.
Now you can test the web site access.
Carry out appropriate testing to ensure the directives used are working.
For rewrites check that the correct site is resolved.
For auth, firstly ensure you have created the actual web site folder or subfolder, and then browse to your newly secured location ie
www./yourdomain.com/ibayname/foldername/subfoldername
www.yourdomain.com/ibayname/foldername/subfoldername
You will be asked for a user Id and password.
You will be asked for a user Id and password.
Enter any combination that is allowed by your configuration to gain access, ie is in your password file, is any sme user, or is a specfied sme user.
Enter any combination that is allowed by your configuration to gain access, ie is in your password file, is any sme user, or is a specfied sme user.
=== Deletion procedure ===
===Deletion procedure===
To undo any changes you make using this method, do the following, replacing filenames with those actually used
To undo any changes you make using this method, do the following, replacing filenames with those actually used
sv s /service/httpd-e-smith
sv s /service/httpd-e-smith
==Using a .htaccess file to configure htaccess requirements - not recommended==
These instructions are added here for general interest. Users should heed recommendations in this article & instead use custom templates where possible to achieve the same end result.
These instructions are added here for general interest. Users should heed recommendations in this article & instead use custom templates where possible to achieve the same end result.
AllowOverride can be set to values other than "All", and should be set as narrowly as possible to meet users' needs. Consult the [http://httpd.apache.org/docs/current/mod/core.html#allowoverride Apache documentation] for valid values of this parameter. This is only required if there is a legitimate need for system users to independently change web access controls. If this is enabled, the system administrator should regularly monitor the contents of .htaccess files to ensure security is not compromised.
AllowOverride can be set to values other than "All", and should be set as narrowly as possible to meet users' needs. Consult the [http://httpd.apache.org/docs/current/mod/core.html#allowoverride Apache documentation] for valid values of this parameter. This is only required if there is a legitimate need for system users to independently change web access controls. If this is enabled, the system administrator should regularly monitor the contents of .htaccess files to ensure security is not compromised.
== Additional Information ==
See these resources for further information about creating and using htaccess although much of that information is not applicable to the method outlined in this HOWTO.
See these resources for further information about creating and using htaccess. Much of the information is not directly applicable to the method outlined in this HOWTO, but it will assist in determining the contents of the custom template fragment (ie the directives to use).
http://httpd.apache.org/docs/current/howto/htaccess.html
http://www.freewebmasterhelp.com/tutorials/htaccess/
http://www.freewebmasterhelp.com/tutorials/htaccess/
