directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dran...@apache.org
Subject [1/3] directory-kerby git commit: Refined README and cleared client tools
Date Sat, 23 Jan 2016 15:15:25 GMT
Repository: directory-kerby
Updated Branches:
  refs/heads/trunk efab9a6fe -> ce724a932


Refined README and cleared client tools


Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/0384dfc4
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/0384dfc4
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/0384dfc4

Branch: refs/heads/trunk
Commit: 0384dfc48d22e9e6ec26170ae35d75b390185a6e
Parents: efab9a6
Author: Kai Zheng <kai.zheng@intel.com>
Authored: Sat Jan 23 23:06:39 2016 +0800
Committer: Kai Zheng <kai.zheng@intel.com>
Committed: Sat Jan 23 23:06:39 2016 +0800

----------------------------------------------------------------------
 README.md                                       | 46 ++++++++++----------
 .../kerby/kerberos/tool/kinit/KinitTool.java    |  2 +
 .../kerby/kerberos/tool/klist/KlistTool.java    |  2 +
 .../kerby/kerberos/tool/kadmin/KadminTool.java  |  3 ++
 4 files changed, 31 insertions(+), 22 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/0384dfc4/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index f356121..0b1fc4c 100644
--- a/README.md
+++ b/README.md
@@ -62,25 +62,26 @@ Please look at [Kerby KDC](kerby-dist/README.md) for details.
 ### Kerberos Crypto and Encryption Types
 Implementing des, des3, rc4, aes, camellia encryption and corresponding checksum types
 Interoperates with MIT Kerberos and Microsoft AD
-Independent of Kerberos code in JRE, but rely on JCE
+Independent of Kerberos code in JRE, but relies on JCE
+Similar to [MIT krb5 encryption types](http://web.mit.edu/kerberos/krb5-1.14/doc/admin/conf_files/kdc_conf.html#encryption-types):
 
 | Encryption Type | Description |
 | --------------- | ----------- |
 | des-cbc-crc | DES cbc mode with CRC-32 (weak) |
 | des-cbc-md4 | DES cbc mode with RSA-MD4 (weak) |
-| des-cbc-md5 |	DES cbc mode with RSA-MD5 (weak) |
-| des3-cbc-sha1 des3-hmac-sha1 des3-cbc-sha1-kd |	Triple DES cbc mode with HMAC/sha1 |
-| des-hmac-sha1 |	DES with HMAC/sha1 (weak) |
-| aes256-cts-hmac-sha1-96 aes256-cts AES-256 	| CTS mode with 96-bit SHA-1 HMAC |
-| aes128-cts-hmac-sha1-96 aes128-cts AES-128 	| CTS mode with 96-bit SHA-1 HMAC |
-| arcfour-hmac rc4-hmac arcfour-hmac-md5 |	RC4 with HMAC/MD5 |
-| arcfour-hmac-exp rc4-hmac-exp arcfour-hmac-md5-exp |	Exportable RC4 with HMAC/MD5 (weak)
|
-| camellia256-cts-cmac camellia256-cts |	Camellia-256 CTS mode with CMAC |
-| camellia128-cts-cmac camellia128-cts |	Camellia-128 CTS mode with CMAC |
-| des |	The DES family: des-cbc-crc, des-cbc-md5, and des-cbc-md4 (weak) |
-| des3 |	The triple DES family: des3-cbc-sha1 |
-| aes |	The AES family: aes256-cts-hmac-sha1-96 and aes128-cts-hmac-sha1-96 |
-| rc4 |	The RC4 family: arcfour-hmac |
+| des-cbc-md5 | DES cbc mode with RSA-MD5 (weak) |
+| des3-cbc-sha1 des3-hmac-sha1 des3-cbc-sha1-kd | Triple DES cbc mode with HMAC/sha1 |
+| des-hmac-sha1 | DES with HMAC/sha1 (weak) |
+| aes256-cts-hmac-sha1-96 aes256-cts AES-256 | CTS mode with 96-bit SHA-1 HMAC |
+| aes128-cts-hmac-sha1-96 aes128-cts AES-128 | CTS mode with 96-bit SHA-1 HMAC |
+| arcfour-hmac rc4-hmac arcfour-hmac-md5 | RC4 with HMAC/MD5 |
+| arcfour-hmac-exp rc4-hmac-exp arcfour-hmac-md5-exp | Exportable RC4 with HMAC/MD5 (weak)
|
+| camellia256-cts-cmac camellia256-cts | Camellia-256 CTS mode with CMAC |
+| camellia128-cts-cmac camellia128-cts | Camellia-128 CTS mode with CMAC |
+| des | The DES family: des-cbc-crc, des-cbc-md5, and des-cbc-md4 (weak) |
+| des3 | The triple DES family: des3-cbc-sha1 |
+| aes | The AES family: aes256-cts-hmac-sha1-96 and aes128-cts-hmac-sha1-96 |
+| rc4 | The RC4 family: arcfour-hmac |
 | camellia | The Camellia family: camellia256-cts-cmac and camellia128-cts-cmac |
 
 ### Identity Backend
@@ -106,18 +107,19 @@ A standalone KDC server that can integrate various identity backends
including:
   - With better throughput, lower latency.
 
 ### Tools
-- kdcinit:
-  - This is used to initialize and prepare all kinds of KDC side materials, like initializing
concrete back end, setting up master keys, 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.
+- kdcinit:
+  - This is used to initialize and prepare all kinds of KDC side materials, like initializing
concrete back end, setting up master keys, necessary principals (tgs, kadmin) and etc.
+- kadmin:
+  - Command-line interfaces to the Kerby administration system.
 
-#### Kerby Lib Projects
+#### Kerby Common Projects
 - kerby-asn1. A model driven ASN-1 encoding and decoding framework
 - kerby-config. A unified configuration API that aims to support various configuration file
formats, like XML, INI, even Java Map and Properties.
+- kerby-util. Common utilities used by project.
 
 ### Dependency
 - The core part is ensured to only depend on the JRE and SLF4J. Every external dependency
is taken carefully and maintained separately.
@@ -172,11 +174,11 @@ Apache License V2.0
 ### How to contribute
 - Git repo in Apache: https://git-wip-us.apache.org/repos/asf/directory-kerby.git
 - Umbrella JIRA: it's tracked in the master JIRA [DIRKRB-102](https://issues.apache.org/jira/browse/DIRKRB-102),
and find tasks there.
-- The Directory Developers List: dev@directory.apache.org [Subscribe](dev-subscribe@directory.apache.org)
-- The Kerby Developers List: kerby@directory.apache.org [Subscribe](kerby-subscribe@directory.apache.org)
+- Directory Developers List: dev@directory.apache.org [Subscribe](dev-subscribe@directory.apache.org)
+- Kerby Developers List: kerby@directory.apache.org [Subscribe](kerby-subscribe@directory.apache.org)
 
 ### Downloads
-- [Version 1.0.0-RC1](https://directory.apache.org/kerby/download/download-sources.html)
+- [Release 1.0.0-RC1](https://directory.apache.org/kerby/download/download-sources.html)
 
 ### News
 - Sep 23, the first release 1.0.0-RC1 of Kerby was released.

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/0384dfc4/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/kinit/KinitTool.java
----------------------------------------------------------------------
diff --git a/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/kinit/KinitTool.java
b/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/kinit/KinitTool.java
index 7014960..122f842 100644
--- a/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/kinit/KinitTool.java
+++ b/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/kinit/KinitTool.java
@@ -44,6 +44,8 @@ import java.util.Scanner;
 
 /**
  * kinit like tool
+ *
+ * Ref. MIT kinit command tool usage.
  */
 public class KinitTool {
 

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/0384dfc4/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/klist/KlistTool.java
----------------------------------------------------------------------
diff --git a/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/klist/KlistTool.java
b/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/klist/KlistTool.java
index 41b251e..0d8f8d0 100644
--- a/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/klist/KlistTool.java
+++ b/kerby-tool/client-tool/src/main/java/org/apache/kerby/kerberos/tool/klist/KlistTool.java
@@ -40,6 +40,8 @@ import java.util.List;
 
 /**
  * klist like tool
+ *
+ * Ref. MIT klist command tool usage.
  */
 public class KlistTool {
 

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/0384dfc4/kerby-tool/kdc-tool/src/main/java/org/apache/kerby/kerberos/tool/kadmin/KadminTool.java
----------------------------------------------------------------------
diff --git a/kerby-tool/kdc-tool/src/main/java/org/apache/kerby/kerberos/tool/kadmin/KadminTool.java
b/kerby-tool/kdc-tool/src/main/java/org/apache/kerby/kerberos/tool/kadmin/KadminTool.java
index 970f7cb..7845270 100644
--- a/kerby-tool/kdc-tool/src/main/java/org/apache/kerby/kerberos/tool/kadmin/KadminTool.java
+++ b/kerby-tool/kdc-tool/src/main/java/org/apache/kerby/kerberos/tool/kadmin/KadminTool.java
@@ -44,6 +44,9 @@ import java.io.IOException;
 import java.util.Map;
 import java.util.Scanner;
 
+/**
+ * Ref. MIT kadmin command tool usage.
+ */
 public class KadminTool {
     private static final Logger LOG = LoggerFactory.getLogger(KadminTool.class);
     private static File confDir;


Mime
View raw message