directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From plusplusjia...@apache.org
Subject svn commit: r1693846 - in /directory/site/trunk/content/kerby: ./ user-guide/
Date Mon, 03 Aug 2015 02:13:04 GMT
Author: plusplusjiajia
Date: Mon Aug  3 02:13:04 2015
New Revision: 1693846

URL: http://svn.apache.org/r1693846
Log:
Update kerby's user guide and developer guide.

Added:
    directory/site/trunk/content/kerby/user-guide/3.1-kdcinit.mdtext
    directory/site/trunk/content/kerby/user-guide/3.2-kadmin.mdtext
    directory/site/trunk/content/kerby/user-guide/3.3-kinit.mdtext
    directory/site/trunk/content/kerby/user-guide/3.4-klist.mdtext
Removed:
    directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext
    directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext
    directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext
Modified:
    directory/site/trunk/content/kerby/developer-guide.mdtext
    directory/site/trunk/content/kerby/features.mdtext
    directory/site/trunk/content/kerby/user-guide.mdtext
    directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext
    directory/site/trunk/content/kerby/user-guide/3-tools.mdtext
    directory/site/trunk/content/kerby/user-guide/4-identity-backend.mdtext

Modified: directory/site/trunk/content/kerby/developer-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/developer-guide.mdtext?rev=1693846&r1=1693845&r2=1693846&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/developer-guide.mdtext (original)
+++ directory/site/trunk/content/kerby/developer-guide.mdtext Mon Aug  3 02:13:04 2015
@@ -32,10 +32,18 @@ To get the source, you will need to have
 The git repository is mirrored to Github: <https://github.com/apache/directory-kerby/>.
 
 
-## Build
+## Package
 
     mvn clean package
 
+	You may need to pass through using -DskipTests.
+
+## Install
+
+To install the JARs in your ~/.m2/ directory, use the install target.
+
+    mvn clean install
+
 	
 ## Setup Intellij
 

Modified: directory/site/trunk/content/kerby/features.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/features.mdtext?rev=1693846&r1=1693845&r2=1693846&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/features.mdtext (original)
+++ directory/site/trunk/content/kerby/features.mdtext Mon Aug  3 02:13:04 2015
@@ -56,6 +56,7 @@ Following features are (already) support
     * Netty based implementation for better throughput, lower latency.
 
 * Tools:
+    * kdcinit: Initialize and prepare all kinds of KDC side materials, like initializing
concrete back end, setting up necessary principals (tgs, kadmin) and etc.
     * kadmin: Command-line interfaces to the Kerby administration system.
     * kinit: Obtains and caches an initial ticket-granting ticket for principal.
     * klist: Lists the Kerby principal and tickets held in a credentials cache, or the keys
held in a keytab file.

Modified: directory/site/trunk/content/kerby/user-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide.mdtext?rev=1693846&r1=1693845&r2=1693846&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide.mdtext Mon Aug  3 02:13:04 2015
@@ -29,9 +29,10 @@ This is a simple guide to help users and
     * [2.3 - KdcServer](user-guide/2.3-kdcserver.html)
     * [2.4 - SimpleKdcServer](user-guide/2.4-simplekdcserver.html)
 * [3 - Tools](user-guide/3-tools.html)
-    * [3.1 - kadmin](user-guide/3.1-kadmin.html)
-    * [3.2 - kinit](user-guide/3.2-kinit.html)
-    * [3.3 - klist](user-guide/3.3-klist.html)
+    * [3.1 - kdcinit](user-guide/3.1-kdcinit.html)
+    * [3.2 - kadmin](user-guide/3.2-kadmin.html)
+    * [3.3 - kinit](user-guide/3.3-kinit.html)
+    * [3.4 - klist](user-guide/3.4-klist.html)
 * [4 - Identity Backend](user-guide/4-identity-backend.html)
 * [5 - Kerberos Crypto and Encryption Types](user-guide/5-crypto-and-encryption-types.html)
 * [6 - Network Support](user-guide/6-network-support.html)

Modified: directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext?rev=1693846&r1=1693845&r2=1693846&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext Mon Aug  3 02:13:04
2015
@@ -29,25 +29,41 @@ The distribution of Kerby.
 
 ### To run with a standalone kdc server, kinit and kadmin
 
-* Generate libraries for distribution:
+* 1. Generate libraries for distribution:
 
     $ mvn package -Pdist
+	
+* 2. Run kdcinit:
 
-* Run kadmin to add principals:
+    $ cd kerby-dist/kdc-dist
+    $ sh bin/kdcinit.sh [server-conf-dir] [keytab]
 
-    $ sh kerby-dist/tool-dist/bin/kadmin.sh [server-conf-dir]
+    The admin principal will be exported into [keytab], it will be used by kadmin tool for
the authentication. 
+
+* 3. Run kadmin to add principals:
+
+    $ cd kerby-dist/kdc-dist
+    $ sh bin/kadmin.sh [server-conf-dir]
 
   In kadmin, you can type "?" for help. For now, the kadmin only supports to add principals
to json-backend. (Working in progress).
 
-* Start kerby-kdc-server:
+* 4. Start kerby-kdc-server:
+
+    $ cd kerby-dist/kdc-dist
+    $ sh bin/start-kdc.sh –start [server-conf-dir] [work-dir]
 
-    $ sh kerby-dist/kdc-dist/bin/start-kdc.sh –start [server-conf-dir] [work-dir]
+* 5. Run kinit:
 
-* Run kinit:
+    $ cd kerby-dist/tool-dist
+    $ sh bin/kinit.sh [principal-name]
+	
+* 6. Run klist:
 
-    $ sh kerby-dist/tool-dist/bin/kinit.sh [principal-name]
+    $ cd kerby-dist/tool-dist
+    $ sh bin/klist.sh -c [credentials-cache]
 
-  If you don't specify [server-conf-dir] in step 2 or 3, it will be set as /etc/kerby. In
[server-conf-dir], there should be kdc.conf, backend.conf. And in /etc/, there should be krb5.conf.
+  If you don't specify [server-conf-dir] in step 2, 3 or 4, it will be set as /etc/kerby.
In [server-conf-dir], there should be kdc.conf, backend.conf. 
+  And if you don't specify [client -conf-dir] in step 5, it will be set as /etc/, there should
be krb5.conf.
 
 An example of kdc.conf:
 

Modified: directory/site/trunk/content/kerby/user-guide/3-tools.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3-tools.mdtext?rev=1693846&r1=1693845&r2=1693846&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3-tools.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/3-tools.mdtext Mon Aug  3 02:13:04 2015
@@ -3,8 +3,8 @@ NavPrev: 2.4-simplekdcserver.html
 NavPrevtext: 2.4 - SimpleKdcServer
 NavUp: ../user-guide.html
 NavUpText: User Guide
-NavNext: 3.1-kadmin.html
-NavNextText: 3.1 - kadmin
+NavNext: 3.1-kdcinit.html
+NavNextText: 3.1 - kdcinit
 Notice: 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
@@ -27,6 +27,7 @@ Kerby provides tools including both clie
 
 ## Table of content
 
-* [3.1 - kadmin](3.1-kadmin.html)
-* [3.2 - kinit](3.2-kinit.html)
-* [3.3 - klist](3.3-klist.html)
\ No newline at end of file
+* [3.1 - kdcinit](3.1-kdcinit.html)
+* [3.2 - kadmin](3.2-kadmin.html)
+* [3.3 - kinit](3.3-kinit.html)
+* [3.4 - klist](3.4-klist.html)
\ No newline at end of file

Added: directory/site/trunk/content/kerby/user-guide/3.1-kdcinit.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.1-kdcinit.mdtext?rev=1693846&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.1-kdcinit.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/3.1-kdcinit.mdtext Mon Aug  3 02:13:04 2015
@@ -0,0 +1,33 @@
+Title: 3.1 - kdcinit
+NavPrev: 3-tools.html
+NavPrevText: 3 - tools
+NavUp: 3-tools.html
+NavUpText: 3 - tools
+NavNext: 3.2-kadmin.html
+NavNextText: 3.2 - kadmin
+Notice: 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.
+
+# 3.1 - kdcinit
+
+### SYNOPSIS
+
+kdcinit [conf_dir][keytab]
+
+### DESCRIPTION
+
+kdcinit is used by admin to initialize and prepare all kinds of KDC side materials, like
initializing concrete back end, setting necessary principals (tgs, kadmin) and etc.
\ No newline at end of file

Added: directory/site/trunk/content/kerby/user-guide/3.2-kadmin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.2-kadmin.mdtext?rev=1693846&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.2-kadmin.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/3.2-kadmin.mdtext Mon Aug  3 02:13:04 2015
@@ -0,0 +1,47 @@
+Title: 3.2 - kadmin
+NavPrev: 3.1-kdcinit.html
+NavPrevText: 3.1 - kdcinit
+NavUp: 3-tools.html
+NavUpText: 3 - tools
+NavNext: 3.3-kinit.html
+NavNextText: 3.3 - kinit
+Notice: 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.
+	
+# 3.2 - kadmin
+
+### DESCRIPTION
+
+kadmin is command-line interfaces to the Kerberos V5 administration system. kadmin provides
for the maintenance of Kerberos principals, password policies, and service key tables (keytabs).
+
+### Commands
+
+* add_principal
+
+* modify_principal
+
+* rename_principal
+
+* delete_principal
+
+* change_password
+
+* get_principal
+
+* ktadd
+
+* ktremove
\ No newline at end of file

Added: directory/site/trunk/content/kerby/user-guide/3.3-kinit.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.3-kinit.mdtext?rev=1693846&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.3-kinit.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/3.3-kinit.mdtext Mon Aug  3 02:13:04 2015
@@ -0,0 +1,33 @@
+Title: 3.3 - kinit
+NavPrev: 3.2-kadmin.html
+NavPrevText: 3.2 - kadmin
+NavUp: 3-tools.html
+NavUpText: 3 - tools
+NavNext: 3.4-klist.html
+NavNextText: 3.4 - klist
+Notice: 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.
+	
+# 3.3 - kinit
+
+### SYNOPSIS
+
+kinit [-V] [-l lifetime] [-s start_time] [-r renewable_life] [-p | -P] [-f | -F] [-a] [-A]
[-C] [-E] [-v] [-R] [-k [-t keytab_file]] [-c cache_name] [-n] [-S service_name] [-I input_ccache]
[-T armor_ccache] [-X attribute[=value]] [principal]
+
+### DESCRIPTION
+
+kinit obtains and caches an initial ticket-granting ticket for principal.
\ No newline at end of file

Added: directory/site/trunk/content/kerby/user-guide/3.4-klist.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.4-klist.mdtext?rev=1693846&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.4-klist.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/3.4-klist.mdtext Mon Aug  3 02:13:04 2015
@@ -0,0 +1,33 @@
+Title: 3.4 - klist
+NavPrev: 3.3-kinit.html
+NavPrevText: 3.3 - kinit
+NavUp: 3-tools.html
+NavUpText: 3 - tools
+NavNext: 4-identity-backend.html
+NavNextText: 4 - Identity Backend
+Notice: 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.
+
+# 3.4 - klist
+
+### SYNOPSIS
+
+klist [-e] [[-c] [-l] [-A] [-f] [-s] [-a [-n]]] [-C] [-k [-t] [-K]] [-V] [cache_name|keytab_name]
+
+### DESCRIPTION
+
+klist lists the Kerberos principal and Kerberos tickets held in a credentials cache, or the
keys held in a keytab file.
\ No newline at end of file

Modified: directory/site/trunk/content/kerby/user-guide/4-identity-backend.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/4-identity-backend.mdtext?rev=1693846&r1=1693845&r2=1693846&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/4-identity-backend.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/4-identity-backend.mdtext Mon Aug  3 02:13:04
2015
@@ -1,6 +1,6 @@
 Title: 4 - Identity Backend
-NavPrev: 3.3-klist.html
-NavPrevtext: 3.3 - klist
+NavPrev: 3.4-klist.html
+NavPrevtext: 3.4 - klist
 NavUp: ../user-guide.html
 NavUpText: User Guide
 NavNext: 5-crypto-and-encryption-types.html



Mime
View raw message