From 2dc525f1c395b47b42ca2d8ea8091e707f8dc1b9 Mon Sep 17 00:00:00 2001
From: Wendy Smoak <wsmoak@apache.org>
Date: Sun, 18 Feb 2007 04:21:16 +0000
Subject: [PATCH] Document Plexus Security configuration for Archiva. MRM-283

git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@508863 13f79535-47bb-0310-9956-ffa450edef68
---
 .../apt/guides/security-configuration.apt     | 87 +++++++++++++++++++
 archiva-site/src/site/site.xml                |  3 +-
 2 files changed, 89 insertions(+), 1 deletion(-)
 create mode 100644 archiva-site/src/site/apt/guides/security-configuration.apt

diff --git a/archiva-site/src/site/apt/guides/security-configuration.apt b/archiva-site/src/site/apt/guides/security-configuration.apt
new file mode 100644
index 000000000..1a6edc847
--- /dev/null
+++ b/archiva-site/src/site/apt/guides/security-configuration.apt
@@ -0,0 +1,87 @@
+ ------
+ Archiva Security Configuration
+ ------
+ The Maven Team
+ ------
+ 17 February 2007
+ ------
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements.  See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership.  The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License.  You may obtain a copy of the License at
+~~
+~~   http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied.  See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Archiva Security Configuration
+
+* Properties
+
+ Archiva makes use of Plexus Security to handle user ids, passwords and roles.
+ 
+ Security properties and password rules can be configured in the
+ <<<security.properties>>> file, which by default is searched for in:
+
+ * <<<~/.m2/security.properties>>>
+ 
+ * <<<$ARCHIVA_HOME/conf/security.properties>>>
+ 
+ * <<<$ARCHIVA_HOME/apps/archiva/conf/security.properties>>>
+ 
+ []
+ 
+ (In the above list, <<<~>>> is the home directory of the user who is running
+ Archiva, and <<<$ARCHIVA_HOME>>> is the directory where Archiva is installed,
+ such as <<</opt/archiva-1.0-SNAPSHOT>>>.)
+ 
+~~ TODO: Link to plexus-security documentation when available
+
+ Following are some of the properties you can modify.  For a complete list,
+ consult the default properties file in Plexus Security's svn repo:
+ {{{http://svn.codehaus.org/plexus/plexus-security/trunk/configuration/src/main/resources/org/codehaus/plexus/security/config-defaults.properties}
+ config-defaults.properties}}
+
++-----+
+# Security Policies
+#security.policy.password.encoder=
+security.policy.password.previous.count=6
+security.policy.password.expiration.days=90
+security.policy.allowed.login.attempt=3
+
+# Password Rules
+security.policy.password.rule.alphanumeric.enabled=false
+security.policy.password.rule.alphacount.enabled=true
+security.policy.password.rule.alphacount.minimum=1
+security.policy.password.rule.characterlength.enabled=true
+security.policy.password.rule.characterlength.minimum=1
+security.policy.password.rule.characterlength.maximum=8
+security.policy.password.rule.musthave.enabled=true
+security.policy.password.rule.numericalcount.enabled=true
+security.policy.password.rule.numericalcount.minimum=1
+security.policy.password.rule.reuse.enabled=true
+security.policy.password.rule.nowhitespace.enabled=true
++-----+
+
+ <<Note:>> Archiva's list of configuration files is <itself> configurable, and
+ can be found in:
+ <<<$ARCHIVA_HOME/apps/archiva/webapp/WEB-INF/classes/META-INF/plexus/application.xml>>>
+ 
+* Database
+
+ TODO
+
+ * {{{http://docs.codehaus.org/display/MAVENUSER/Archiva+User+DB+on+Derby+Network+Server}
+   Archiva User DB on Derby Network Server}}
diff --git a/archiva-site/src/site/site.xml b/archiva-site/src/site/site.xml
index 58333a647..b2d1b5567 100644
--- a/archiva-site/src/site/site.xml
+++ b/archiva-site/src/site/site.xml
@@ -29,9 +29,10 @@
       <item name="Getting Started" href="/guides/getting-started/index.html"/>
       <item name="FAQ" href="http://docs.codehaus.org/display/MAVENUSER/Archiva+FAQ"/>
       <item name="Maven Configuration" href="/guides/getting-started/maven-configuration.html"/>
+      <item name="Security Configuration" href="/guides/security-configuration.html"/>
       <item name="Developing" href="/guides/developing/index.html"/>
     </menu>
-
+    
     <menu ref="reports" inherit="bottom"/>
   </body>
   <skin>
-- 
2.39.5