You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by pl...@apache.org on 2015/07/09 07:39:10 UTC
svn commit: r1689989 - in /directory/site/trunk/content/kerby: ./ user-guide/
Author: plusplusjiajia
Date: Thu Jul 9 05:39:10 2015
New Revision: 1689989
URL: http://svn.apache.org/r1689989
Log:
Add the content of developers guide.
Added:
directory/site/trunk/content/kerby/developers-guide.mdtext
directory/site/trunk/content/kerby/user-guide/2-kerberos-library.mdtext
Removed:
directory/site/trunk/content/kerby/user-guide/2-apis.mdtext
Modified:
directory/site/trunk/content/kerby/downloads.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/2.1-krbclient-apis.mdtext
directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext
directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext
directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext
directory/site/trunk/content/kerby/user-guide/3-tools.mdtext
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
Added: directory/site/trunk/content/kerby/developers-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/developers-guide.mdtext?rev=1689989&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/developers-guide.mdtext (added)
+++ directory/site/trunk/content/kerby/developers-guide.mdtext Thu Jul 9 05:39:10 2015
@@ -0,0 +1,48 @@
+Title: Developer's Guide
+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.
+
+# Developer's Guide
+
+This is a simple guide to help developers get going.
+
+## Source Repository
+
+To get the source, you will need to have git installed. Just type the following command to get the latest development version:
+
+ git clone https://git-wip-us.apache.org/repos/asf/directory-kerby.git
+
+## Git Mirror
+
+The git repository is mirrored to Github: <https://github.com/apache/directory-kerby/>.
+
+## Build
+
+ mvn clean package
+
+## Setup Intellij
+
+1. File -> Import Project...
+2. Choose 'directory-kerby' as root directory
+3. Import project from external model -> Maven
+4. Finish
+
+## Issue Tracker
+
+[Jira](https://issues.apache.org/jira/browse/DIRKRB).
+
+
Modified: directory/site/trunk/content/kerby/downloads.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/downloads.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/downloads.mdtext (original)
+++ directory/site/trunk/content/kerby/downloads.mdtext Thu Jul 9 05:39:10 2015
@@ -30,6 +30,7 @@ The Apache Kerby is distributed as a jar
The Apache Kerby is also available as a Maven dependency:
* Kerby Client API
+
<dependency>
<groupId>org.apache.kerby</groupId>
<artifactId>kerb-client-api-all</artifactId>
@@ -37,6 +38,7 @@ The Apache Kerby is also available as a
</dependency>
* Kerby Server API
+
<dependency>
<groupId>org.apache.kerby</groupId>
<artifactId>kerb-server-api-all</artifactId>
@@ -44,6 +46,7 @@ The Apache Kerby is also available as a
</dependency>
* Kerby ASN1
+
<dependency>
<groupId>org.apache.kerby</groupId>
<artifactId>kerby-asn1</artifactId>
@@ -51,6 +54,7 @@ The Apache Kerby is also available as a
</dependency>
* Kerby Simple KDC
+
<dependency>
<groupId>org.apache.kerby</groupId>
<artifactId>kerb-simplekdc</artifactId>
Modified: directory/site/trunk/content/kerby/user-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide.mdtext Thu Jul 9 05:39:10 2015
@@ -18,10 +18,7 @@ Notice: Licensed to the Apache Software
# Kerby User's Guide
-This guide is primarily for people new to Kerby. It will guide through the concepts and how to use Kerby.
-
-## About this guide
-
+This is a simple guide to help users and developers to go through the concepts.
## Table of contents
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=1689989&r1=1689988&r2=1689989&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 Thu Jul 9 05:39:10 2015
@@ -23,4 +23,52 @@ Notice: Licensed to the Apache Software
# 1 - How to begin
This chapter helps you to set up a Apache Kerby kdc server, with the minimal configuration options being explained. That should be enough to get a running server.
+## How to play with the standalone KDC:
+
+The distribution of Kerby.
+
+### To run with a standalone kdc server, kinit and kadmin
+
+* Generate libraries for distribution:
+
+ $ mvn package -Pdist
+
+* Run kadmin to add principals:
+
+ $ sh kerby-dist/tool-dist/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:
+
+ $ sh kerby-dist/kdc-dist/bin/start-kdc.sh Âstart [server-conf-dir] [work-dir]
+
+* Run kinit:
+
+ $ sh kerby-dist/tool-dist/bin/kinit.sh [principal-name]
+
+ 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.
+
+An example of kdc.conf:
+
+ [kdcdefaults]
+ kdc_host = localhost
+ kdc_tcp_port = 8015
+ kdc_realm = TEST.COM
+
+An example of json backend backend.conf:
+
+ kdc_identity_backend = org.apache.kerby.kerberos.kdc.identitybackend.JsonIdentityBackend
+ backend.json.file = /tmp/kerby/jsonbackend
+
+An example of zookeeper backend backend.conf:
+
+ kdc_identity_backend = org.apache.kerby.kerberos.kdc.identitybackend.ZookeeperIdentityBackend
+ data_dir = /tmp/kerby/zookeeper/data
+ data_log_dir = /tmp/kerby/zookeeper/datalog
+
+An example of krb5.conf:
+
+ [libdefaults]
+ kdc_realm=TEST.COM
Added: directory/site/trunk/content/kerby/user-guide/2-kerberos-library.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2-kerberos-library.mdtext?rev=1689989&view=auto
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2-kerberos-library.mdtext (added)
+++ directory/site/trunk/content/kerby/user-guide/2-kerberos-library.mdtext Thu Jul 9 05:39:10 2015
@@ -0,0 +1,33 @@
+Title: 2 - Kerberos library
+NavPrev: 1-how-to-begin.html
+NavPrevtext: 1 - How To Begin
+NavUp: ../user-guide.html
+NavUpText: User Guide
+NavNext: 2.1-krbclient-apis.html
+NavNextText: 2.1 - KrbClient APIs
+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.
+
+# 2 - Kerberos library
+Kerby provides the KrbClient API, Kadmin API, Kerberos Server API and the simplified kdc server APIs.
+
+## Table of content
+
+* [2.1 - KrbClient API](2.1-krbclient-apis.html)
+* [2.2 - Kadmin](2.2-kadmin.html)
+* [2.3 - KdcServer](2.3-kdcserver.html)
+* [2.4 - SimpleKdcServer](2.4-simplekdcserver.html)
\ No newline at end of file
Modified: directory/site/trunk/content/kerby/user-guide/2.1-krbclient-apis.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2.1-krbclient-apis.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2.1-krbclient-apis.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/2.1-krbclient-apis.mdtext Thu Jul 9 05:39:10 2015
@@ -1,8 +1,8 @@
Title: 2.1 - KrbClient APIs
-NavPrev: 2-apis.html
-NavPrevText: 2 - APIs
-NavUp: 2-apis.html
-NavUpText: 2 - APIs
+NavPrev: 2-kerberos-library.html
+NavPrevText: 2 - Kerberos library
+NavUp: 2-kerberos-library.html
+NavUpText: 2 - Kerberos library
NavNext: 2.2-kadmin.html
NavNextText: 2.2 - Kadmin
Notice: Licensed to the Apache Software Foundation (ASF) under one
@@ -22,8 +22,8 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-kerb-client
-============
+# 2.1 - KrbClient APIs
+A Krb client API for applications to interact with KDC.
### Initiate a KrbClient
* Initiate a KrbClient with prepared KrbConfig.
Modified: directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/2.2-kadmin.mdtext Thu Jul 9 05:39:10 2015
@@ -1,8 +1,8 @@
Title: 2.2 - Kadmin
NavPrev: 2.1-krbclient-apis.html
NavPrevText: 2.1 - KrbClient APIs
-NavUp: 2-apis.html
-NavUpText: 2 - APIs
+NavUp: 2-kerberos-library.html
+NavUpText: 2 - Kerberos library
NavNext: 2.3-kdcserver.html
NavNextText: 2.3 - KdcServer
Notice: Licensed to the Apache Software Foundation (ASF) under one
@@ -22,8 +22,8 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-kerb-admin
-============
+# 2.2 - Kadmin
+Server side admin facilities.
### Initiate a Kadmin
* Initiate a Kadmin with confDir.
Modified: directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/2.3-kdcserver.mdtext Thu Jul 9 05:39:10 2015
@@ -1,9 +1,9 @@
Title: 2.3 - KdcServer
NavPrev: 2.2-kadmin.html
NavPrevText: 2.2 - Kadmin
-NavUp: 2-apis.html
-NavUpText: 2 - APIs
-NavNext: 2.3-kdcserver.html
+NavUp: 2-kerberos-library.html
+NavUpText: 2 - Kerberos library
+NavNext: 2.4-simplekdcserver.html
NavNextText: 2.4 - SimpleKdcServer
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -22,8 +22,8 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-kerb-server
-============
+# 2.3 - KdcServer
+Kerberos Server API.
### Initiate kdc server
* Initiate a kdc server with prepared confDir.
@@ -70,7 +70,7 @@ setInnerKdcImpl(innerKdcImpl);
</pre>
### Stop kdc server
-* Start kdc server.
+* Stop kdc server.
<pre>
stop();
</pre>
Modified: directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/2.4-simplekdcserver.mdtext Thu Jul 9 05:39:10 2015
@@ -1,8 +1,8 @@
Title: 2.4 - SimpleKdcServer
NavPrev: 2.3-kdcserver.html
NavPrevText: 2.3 - KdcServer
-NavUp: 2-apis.html
-NavUpText: 2 - APIs
+NavUp: 2-kerberos-library.html
+NavUpText: 2 - Kerberos library
NavNext: 3-tools.html
NavNextText: 3 - tools
Notice: Licensed to the Apache Software Foundation (ASF) under one
@@ -22,8 +22,8 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-kerb-simplekdc
-============
+# 2.4 - SimpleKdcServer
+A simplified Kdc server. It can be imported by other project to work as a kdc server.
### Kdc server
</pre>
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=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3-tools.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/3-tools.mdtext Thu Jul 9 05:39:10 2015
@@ -1,4 +1,6 @@
Title: 3 - Tools
+NavPrev: 2.4-simplekdcserver.html
+NavPrevtext: 2.4 - SimpleKdcServer
NavUp: ../user-guide.html
NavUpText: User Guide
NavNext: 3.1-kadmin.html
@@ -21,9 +23,7 @@ Notice: Licensed to the Apache Software
under the License.
# 3 - Tools
-This chapter helps you to set up a server, with the minimal configuration options being explained. That should be enough to get a running server.
-
-This user guide is **not** intended to be a **LDAP** guide : there are some excellent tutorials or books, we won't try to challenge them !
+Kerby provides tools including both client side and server side.
## Table of content
Modified: directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/3.1-kadmin.mdtext Thu Jul 9 05:39:10 2015
@@ -22,11 +22,7 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-## 3.1 - kadmin
-
-### SYNOPSIS
-
-kadmin [-O|-N] [-r realm] [-p principal] [-q query] [[-c cache_name]|[-k [-t keytab]]|-n] [-w password] [-s admin_server[:port]]
+# 3.1 - kadmin
### DESCRIPTION
Modified: directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/3.2-kinit.mdtext Thu Jul 9 05:39:10 2015
@@ -22,7 +22,7 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-## 3.2 - kinit
+# 3.2 - kinit
### SYNOPSIS
Modified: directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext?rev=1689989&r1=1689988&r2=1689989&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/3.3-klist.mdtext Thu Jul 9 05:39:10 2015
@@ -20,12 +20,12 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-## 3.3 - klist
+# 3.3 - klist
### SYNOPSIS
klist [-e] [[-c] [-l] [-A] [-f] [-s] [-a [-n]]] [-C] [-k [-t] [-K]] [-V] [cache_name|keytab_name]
-#### DESCRIPTION
+### 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