directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject [directory-server] branch master updated: Fixed some of the kerberos-codec javadoc warnings
Date Mon, 13 Aug 2018 22:05:42 GMT
This is an automated email from the ASF dual-hosted git repository.

elecharny pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-server.git


The following commit(s) were added to refs/heads/master by this push:
     new 17bf80c  Fixed some of the kerberos-codec javadoc warnings
17bf80c is described below

commit 17bf80c69c7d6e576c073949a8fd2690fe228b7f
Author: Emmanuel L├ęcharny <elecharny@symas.com>
AuthorDate: Tue Aug 14 00:05:36 2018 +0200

    Fixed some of the kerberos-codec javadoc warnings
---
 .../changepwd/messages/ChangePasswordError.java    |  6 +++---
 .../changepwd/messages/ChangePasswordReply.java    |  6 +++---
 .../changepwd/messages/ChangePasswordRequest.java  |  6 +++---
 .../shared/crypto/checksum/ChecksumEngine.java     |  6 +++---
 .../shared/crypto/checksum/ChecksumHandler.java    | 22 +++++++++++-----------
 .../crypto/encryption/CipherTextHandler.java       |  2 +-
 .../crypto/encryption/Des3CbcSha1KdEncryption.java |  6 ++++++
 .../shared/crypto/encryption/EncryptionEngine.java |  9 +++++++++
 8 files changed, 39 insertions(+), 24 deletions(-)

diff --git a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordError.java
b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordError.java
index bc6ea49..626efa1 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordError.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordError.java
@@ -51,7 +51,7 @@ public class ChangePasswordError extends AbstractPasswordMessage
     /**
      * Creates a new instance of ChangePasswordError.
      *
-     * @param versionNumber
+     * @param versionNumber The version number 
      * @param krbError The KRB-ERROR
      */
     public ChangePasswordError( short versionNumber, KrbError krbError )
@@ -99,9 +99,9 @@ public class ChangePasswordError extends AbstractPasswordMessage
     /**
      * Decodes a {@link ByteBuffer} into a {@link ChangePasswordError}.
      *
-     * @param buf
+     * @param buf The buffer containing the ChangePasswordError to decode
      * @return The {@link ChangePasswordError}.
-     * @throws ChangePasswordException
+     * @throws ChangePasswordException If the decoding failed
      */
     public static ChangePasswordError decode( ByteBuffer buf ) throws ChangePasswordException
     {
diff --git a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordReply.java
b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordReply.java
index c90ab31..a75326f 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordReply.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordReply.java
@@ -53,9 +53,9 @@ public class ChangePasswordReply extends AbstractPasswordMessage
     /**
      * Creates a new instance of ChangePasswordReply.
      *
-     * @param versionNumber
-     * @param applicationReply
-     * @param privateMessage
+     * @param versionNumber The version number
+     * @param applicationReply The application reply
+     * @param privateMessage The private part
      */
     public ChangePasswordReply( short versionNumber, ApRep applicationReply, KrbPriv privateMessage
)
     {
diff --git a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordRequest.java
b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordRequest.java
index 8449b84..df24044 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordRequest.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/changepwd/messages/ChangePasswordRequest.java
@@ -54,9 +54,9 @@ public class ChangePasswordRequest extends AbstractPasswordMessage
     /**
      * Creates a new instance of ChangePasswordRequest.
      *
-     * @param versionNumber
-     * @param authHeader
-     * @param privateMessage
+     * @param versionNumber The version number
+     * @param authHeader The authentication header
+     * @param privateMessage The private part
      */
     public ChangePasswordRequest( short versionNumber, ApReq authHeader, KrbPriv privateMessage
)
     {
diff --git a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ChecksumEngine.java
b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ChecksumEngine.java
index a7c41f6..cd60b80 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ChecksumEngine.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ChecksumEngine.java
@@ -40,9 +40,9 @@ public interface ChecksumEngine
     /**
      * Calculate a checksum given raw bytes and an (optional) key.
      *
-     * @param data
-     * @param key
-     * @param usage 
+     * @param data The data
+     * @param key The key
+     * @param usage The Key usage number
      * @return The checksum value.
      */
     byte[] calculateChecksum( byte[] data, byte[] key, KeyUsage usage );
diff --git a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ChecksumHandler.java
b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ChecksumHandler.java
index 6ceeb29..8ff78fc 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ChecksumHandler.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ChecksumHandler.java
@@ -61,12 +61,12 @@ public class ChecksumHandler
     /**
      * Calculate a checksum based on raw bytes and an (optional) key for keyed checksums.
      *
-     * @param checksumType
-     * @param bytes
-     * @param key
-     * @param usage
-     * @return The {@link Checksum}.
-     * @throws KerberosException
+     * @param checksumType The type of checksum to use
+     * @param bytes The data
+     * @param key The key
+     * @param usage The key usage 
+     * @return The computed {@link Checksum}.
+     * @throws KerberosException If the checksum can't be cmputed
      */
     public Checksum calculateChecksum( ChecksumType checksumType, byte[] bytes, byte[] key,
KeyUsage usage )
         throws KerberosException
@@ -84,11 +84,11 @@ public class ChecksumHandler
     /**
      * Verify a checksum by providing the raw bytes and an (optional) key for keyed checksums.
      *
-     * @param checksum
-     * @param bytes
-     * @param key
-     * @param usage
-     * @throws KerberosException
+     * @param checksum The checksum to verify
+     * @param bytes The data
+     * @param key The key
+     * @param usage The key usage 
+     * @throws KerberosException If the verification failed
      */
     public void verifyChecksum( Checksum checksum, byte[] bytes, byte[] key, KeyUsage usage
) throws KerberosException
     {
diff --git a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/CipherTextHandler.java
b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/CipherTextHandler.java
index 0d4c9bc..4d34e1b 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/CipherTextHandler.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/CipherTextHandler.java
@@ -74,7 +74,7 @@ public class CipherTextHandler
      * @param message The Kerberos object to encode.
      * @param usage The key usage.
      * @return The Kerberos EncryptedData.
-     * @throws KerberosException
+     * @throws KerberosException if the seal failed
      */
     public EncryptedData seal( EncryptionKey key, Asn1Object message, KeyUsage usage ) throws
KerberosException
     {
diff --git a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/Des3CbcSha1KdEncryption.java
b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/Des3CbcSha1KdEncryption.java
index cc5f2d3..4163603 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/Des3CbcSha1KdEncryption.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/Des3CbcSha1KdEncryption.java
@@ -158,6 +158,12 @@ public class Des3CbcSha1KdEncryption extends EncryptionEngine implements
Checksu
      * Derived Key = DK(Base Key, Well-Known Constant)
      * DK(Key, Constant) = random-to-key(DR(Key, Constant))
      * DR(Key, Constant) = k-truncate(E(Key, Constant, initial-cipher-state))
+     * 
+     * @param baseKey The base key to derive
+     * @param usage The key usage
+     * @param n The number of resulting bytes
+     * @param k The number of bytes
+     * @return The derived key
      */
     protected byte[] deriveKey( byte[] baseKey, byte[] usage, int n, int k )
     {
diff --git a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/EncryptionEngine.java
b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/EncryptionEngine.java
index 70b5326..ac10c2c 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/EncryptionEngine.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/EncryptionEngine.java
@@ -208,6 +208,9 @@ public abstract class EncryptionEngine
      * followed by one octet indicated below.
      * 
      *  Kc = DK(base-key, usage | 0x99);
+     *  
+     *  @param usage The key usage
+     *  @return the computed usage Kc
      */
     protected byte[] getUsageKc( KeyUsage usage )
     {
@@ -221,6 +224,9 @@ public abstract class EncryptionEngine
      * followed by one octet indicated below.
      * 
      *  Ke = DK(base-key, usage | 0xAA);
+     *  
+     *  @param usage The key usage
+     *  @return the computed usage Ke
      */
     protected byte[] getUsageKe( KeyUsage usage )
     {
@@ -234,6 +240,9 @@ public abstract class EncryptionEngine
      * followed by one octet indicated below.
      * 
      *  Ki = DK(base-key, usage | 0x55);
+     *  
+     *  @param usage The key usage
+     *  @return the computed usage Ki
      */
     protected byte[] getUsageKi( KeyUsage usage )
     {


Mime
View raw message