You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2010/11/22 12:18:43 UTC
svn commit: r1037673 - in
/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos:
./ codec/krbSafe/ codec/krbSafeBody/ components/ messages/
Author: elecharny
Date: Mon Nov 22 11:18:41 2010
New Revision: 1037673
URL: http://svn.apache.org/viewvc?rev=1037673&view=rev
Log:
Cleaned some Javadoc and added some missing javadocs.Nothing serious.
Modified:
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosConstants.java
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeGrammar.java
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeStatesEnum.java
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafeBody/KrbSafeBodyGrammar.java
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/KrbSafeBody.java
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KerberosMessage.java
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbError.java
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbSafe.java
Modified: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosConstants.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosConstants.java?rev=1037673&r1=1037672&r2=1037673&view=diff
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosConstants.java (original)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosConstants.java Mon Nov 22 11:18:41 2010
@@ -150,6 +150,21 @@ public class KerberosConstants
public static final int KDC_REQ_BODY_ADDRESSES_TAG = 0xA9;
public static final int KDC_REQ_BODY_ENC_AUTHZ_DATA_TAG = 0xAA;
public static final int KDC_REQ_BODY_ADDITIONAL_TICKETS_TAG = 0xAB;
+
+ /** KrbSafe tags */
+ public static final int KRB_SAFE_TAG = 0x74;
+ public static final int KRB_SAFE_PVNO_TAG = 0xA0;
+ public static final int KRB_SAFE_MSGTYPE_TAG = 0xA1;
+ public static final int KRB_SAFE_SAFE_BODY_TAG = 0xA2;
+ public static final int KRB_SAFE_CKSUM_TAG = 0xA3;
+
+ /** KrbSafeBody tags */
+ public static final int KRB_SAFE_BODY_USER_DATA_TAG = 0xA0;
+ public static final int KRB_SAFE_BODY_TIMESTAMP_TAG = 0xA1;
+ public static final int KRB_SAFE_BODY_USEC_TAG = 0xA2;
+ public static final int KRB_SAFE_BODY_SEQ_NUMBER_TAG = 0xA3;
+ public static final int KRB_SAFE_BODY_SENDER_ADDRESS_TAG = 0xA4;
+ public static final int KRB_SAFE_BODY_RECIPIENT_ADDRESS_TAG = 0xA5;
/** PaData tags */
public static final int PADATA_TYPE_TAG = 0xA1;
@@ -163,21 +178,6 @@ public class KerberosConstants
public static final int TRANSITED_ENCODING_TR_TYPE_TAG = 0xA0;
public static final int TRANSITED_ENCODING_CONTENTS_TAG = 0xA1;
- /** KrbSafeBody tags */
- public static final int KRB_SAFE_BODY_USER_DATA_TAG = 0xA0;
- public static final int KRB_SAFE_BODY_TIMESTAMP_TAG = 0xA1;
- public static final int KRB_SAFE_BODY_USEC_TAG = 0xA2;
- public static final int KRB_SAFE_BODY_SEQ_NUMBER_TAG = 0xA3;
- public static final int KRB_SAFE_BODY_SENDER_ADDRESS_TAG = 0xA4;
- public static final int KRB_SAFE_BODY_RECIPIENT_ADDRESS_TAG = 0xA5;
-
- /** KrbSafe tags */
- public static final int KRB_SAFE_TAG = 0x74;
- public static final int KRB_SAFE_PVNO_TAG = 0xA0;
- public static final int KRB_SAFE_MSGTYPE_TAG = 0xA1;
- public static final int KRB_SAFE_SAFE_BODY_TAG = 0xA2;
- public static final int KRB_SAFE_CKSUM_TAG = 0xA3;
-
/** EncKrbPrivPart */
public static final int ENC_KRB_PRIV_PART_TAG = 0x7C;
public static final int ENC_KRB_PRIV_PART_USER_DATA_TAG = 0xA0;
Modified: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeGrammar.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeGrammar.java?rev=1037673&r1=1037672&r2=1037673&view=diff
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeGrammar.java (original)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeGrammar.java Mon Nov 22 11:18:41 2010
@@ -36,7 +36,7 @@ import org.slf4j.LoggerFactory;
/**
- * This class implements the KrbSafe structure. All the actions are declared
+ * This class implements the KRB-SAFE structure. All the actions are declared
* in this class. As it is a singleton, these declaration are only done once. If
* an action is to be added or modified, this is where the work is to be done !
*
@@ -65,7 +65,7 @@ public final class KrbSafeGrammar extend
super.transitions = new GrammarTransition[KrbSafeStatesEnum.LAST_KRB_SAFE_STATE.ordinal()][256];
// ============================================================================================
- // KrbSafe
+ // KRB-SAFE
// ============================================================================================
// --------------------------------------------------------------------------------------------
// Transition from KrbSafe init to KrbSafe tag
Modified: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeStatesEnum.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeStatesEnum.java?rev=1037673&r1=1037672&r2=1037673&view=diff
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeStatesEnum.java (original)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafe/KrbSafeStatesEnum.java Mon Nov 22 11:18:41 2010
@@ -39,7 +39,7 @@ public enum KrbSafeStatesEnum implements
// ----- KRB-SAFE component --------------------------------------
KRB_SAFE_TAG_STATE, // 1
- KRB_SAFE_SEQ_STATE, // 2
+ KRB_SAFE_SEQ_STATE, // 2
KRB_SAFE_PVNO_TAG_STATE, // 3
KRB_SAFE_PVNO_STATE, // 4
@@ -48,6 +48,7 @@ public enum KrbSafeStatesEnum implements
KRB_SAFE_MSGTYPE_STATE, // 6
KRB_SAFE_SAFE_BODY_TAG_STATE, // 7
+
KRB_SAFE_CKSUM_TAG_STATE, // 8
// End
Modified: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafeBody/KrbSafeBodyGrammar.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafeBody/KrbSafeBodyGrammar.java?rev=1037673&r1=1037672&r2=1037673&view=diff
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafeBody/KrbSafeBodyGrammar.java (original)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/codec/krbSafeBody/KrbSafeBodyGrammar.java Mon Nov 22 11:18:41 2010
@@ -38,7 +38,7 @@ import org.slf4j.LoggerFactory;
/**
- * This class implements the KrbSafeBody structure. All the actions are declared
+ * This class implements the KRB-SAFE-BODY structure. All the actions are declared
* in this class. As it is a singleton, these declaration are only done once. If
* an action is to be added or modified, this is where the work is to be done !
*
@@ -70,7 +70,7 @@ public final class KrbSafeBodyGrammar ex
// KrbSafeBody
// ============================================================================================
// --------------------------------------------------------------------------------------------
- // Transition from KrbSafeBody init to KrbError seq
+ // Transition from KrbSafeBody init to KrbSafeBody seq
// --------------------------------------------------------------------------------------------
// KRB-SAFE-BODY ::= SEQUENCE {
super.transitions[KrbSafeBodyStatesEnum.START_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] = new GrammarTransition(
Modified: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/KrbSafeBody.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/KrbSafeBody.java?rev=1037673&r1=1037672&r2=1037673&view=diff
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/KrbSafeBody.java (original)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/KrbSafeBody.java Mon Nov 22 11:18:41 2010
@@ -38,6 +38,9 @@ import org.slf4j.LoggerFactory;
/**
+ * Class representing KRB-SAFE-BODY message
+ *
+ * <pre>
* KRB-SAFE-BODY ::= SEQUENCE {
* user-data [0] OCTET STRING,
* timestamp [1] KerberosTime OPTIONAL,
@@ -46,7 +49,7 @@ import org.slf4j.LoggerFactory;
* s-address [4] HostAddress,
* r-address [5] HostAddress OPTIONAL
* }
- *
+ *</pre>
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class KrbSafeBody extends AbstractAsn1Object
@@ -75,6 +78,7 @@ public class KrbSafeBody extends Abstrac
/** the recipient's address */
private HostAddress recipientAddress;
+ // Storage for computed lengths
private transient int userDataLen;
private transient int timestampLen;
private transient int usecLen;
@@ -85,6 +89,132 @@ public class KrbSafeBody extends Abstrac
/**
+ * Creates a new instance of KrbSafeBody.
+ */
+ public KrbSafeBody()
+ {
+ }
+
+
+ /**
+ * @return the userData
+ */
+ public byte[] getUserData()
+ {
+ return userData;
+ }
+
+
+ /**
+ * @param userData the userData to set
+ */
+ public void setUserData( byte[] userData )
+ {
+ this.userData = userData;
+ }
+
+
+ /**
+ * @return the timestamp
+ */
+ public KerberosTime getTimestamp()
+ {
+ return timestamp;
+ }
+
+
+ /**
+ * @param timestamp the timestamp to set
+ */
+ public void setTimestamp( KerberosTime timestamp )
+ {
+ this.timestamp = timestamp;
+ }
+
+
+ /**
+ * @return the usec
+ */
+ public int getUsec()
+ {
+ if ( usec == null )
+ {
+ return 0;
+ }
+
+ return usec;
+ }
+
+
+ /**
+ * @param usec the usec to set
+ */
+ public void setUsec( int usec )
+ {
+ this.usec = usec;
+ }
+
+
+ /**
+ * @return the seqNumber
+ */
+ public int getSeqNumber()
+ {
+ if ( seqNumber == null )
+ {
+ return 0;
+ }
+
+ return seqNumber;
+ }
+
+
+ /**
+ * @param seqNumber the seqNumber to set
+ */
+ public void setSeqNumber( int seqNumber )
+ {
+ this.seqNumber = seqNumber;
+ }
+
+
+ /**
+ * @return the senderAddress
+ */
+ public HostAddress getSenderAddress()
+ {
+ return senderAddress;
+ }
+
+
+ /**
+ * @param senderAddress the senderAddress to set
+ */
+ public void setSenderAddress( HostAddress senderAddress )
+ {
+ this.senderAddress = senderAddress;
+ }
+
+
+ /**
+ * @return the recipientAddress
+ */
+ public HostAddress getRecipientAddress()
+ {
+ return recipientAddress;
+ }
+
+
+ /**
+ * @param recipientAddress the recipientAddress to set
+ */
+ public void setRecipientAddress( HostAddress recipientAddress )
+ {
+ this.recipientAddress = recipientAddress;
+ }
+
+
+ /**
* Compute the KRB-SAFE-BODY length:
*
* <pre>
@@ -232,126 +362,6 @@ public class KrbSafeBody extends Abstrac
return buffer;
}
-
-
- /**
- * @return the userData
- */
- public byte[] getUserData()
- {
- return userData;
- }
-
-
- /**
- * @param userData the userData to set
- */
- public void setUserData( byte[] userData )
- {
- this.userData = userData;
- }
-
-
- /**
- * @return the timestamp
- */
- public KerberosTime getTimestamp()
- {
- return timestamp;
- }
-
-
- /**
- * @param timestamp the timestamp to set
- */
- public void setTimestamp( KerberosTime timestamp )
- {
- this.timestamp = timestamp;
- }
-
-
- /**
- * @return the usec
- */
- public int getUsec()
- {
- if ( usec == null )
- {
- return 0;
- }
-
- return usec;
- }
-
-
- /**
- * @param usec the usec to set
- */
- public void setUsec( int usec )
- {
- this.usec = usec;
- }
-
-
- /**
- * @return the seqNumber
- */
- public int getSeqNumber()
- {
- if ( seqNumber == null )
- {
- return 0;
- }
-
- return seqNumber;
- }
-
-
- /**
- * @param seqNumber the seqNumber to set
- */
- public void setSeqNumber( int seqNumber )
- {
- this.seqNumber = seqNumber;
- }
-
-
- /**
- * @return the senderAddress
- */
- public HostAddress getSenderAddress()
- {
- return senderAddress;
- }
-
-
- /**
- * @param senderAddress the senderAddress to set
- */
- public void setSenderAddress( HostAddress senderAddress )
- {
- this.senderAddress = senderAddress;
- }
-
-
- /**
- * @return the recipientAddress
- */
- public HostAddress getRecipientAddress()
- {
- return recipientAddress;
- }
-
-
- /**
- * @param recipientAddress the recipientAddress to set
- */
- public void setRecipientAddress( HostAddress recipientAddress )
- {
- this.recipientAddress = recipientAddress;
- }
-
-
/**
* @see Object#toString()
*/
@@ -359,7 +369,7 @@ public class KrbSafeBody extends Abstrac
{
StringBuilder sb = new StringBuilder();
- sb.append( "KrbSafeBody : {\n" );
+ sb.append( "KRB-SAFE-BODY : {\n" );
sb.append( " user-data: " ).append( StringTools.dumpBytes( userData ) ).append( '\n' );
if ( timestamp != null )
Modified: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KerberosMessage.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KerberosMessage.java?rev=1037673&r1=1037672&r2=1037673&view=diff
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KerberosMessage.java (original)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KerberosMessage.java Mon Nov 22 11:18:41 2010
@@ -30,11 +30,8 @@ import org.apache.directory.shared.kerbe
*/
public abstract class KerberosMessage extends AbstractAsn1Object
{
- /** The Kerberos protocol version number (5). */
- public static final int PVNO = KerberosConstants.KERBEROS_V5;
-
/** The protocol version (should be 5) */
- private int protocolVersionNumber = PVNO;
+ private int protocolVersionNumber = KerberosConstants.KERBEROS_V5;
/** The message type */
private KerberosMessageType messageType;
@@ -47,7 +44,7 @@ public abstract class KerberosMessage ex
*/
public KerberosMessage( KerberosMessageType type )
{
- this( PVNO, type );
+ this( KerberosConstants.KERBEROS_V5, type );
}
Modified: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbError.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbError.java?rev=1037673&r1=1037672&r2=1037673&view=diff
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbError.java (original)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbError.java Mon Nov 22 11:18:41 2010
@@ -39,8 +39,9 @@ import org.slf4j.LoggerFactory;
/**
- * Class representing KrbError message
+ * Class representing KRB-ERROR message
*
+ * <pre>
* KRB-ERROR ::= [APPLICATION 30] SEQUENCE {
* pvno [0] INTEGER (5),
* msg-type [1] INTEGER (30),
@@ -56,7 +57,7 @@ import org.slf4j.LoggerFactory;
* e-text [11] KerberosString OPTIONAL,
* e-data [12] OCTET STRING OPTIONAL
* }
- *
+ * </pre>
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class KrbError extends KerberosMessage
@@ -675,7 +676,7 @@ public class KrbError extends KerberosMe
{
StringBuilder sb = new StringBuilder();
- sb.append( "KrbError : {\n" );
+ sb.append( "KRB-ERROR : {\n" );
sb.append( " pvno: " ).append( getProtocolVersionNumber() ).append( '\n' );
sb.append( " msgType: " ).append( getMessageType() ).append( '\n' );
Modified: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbSafe.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbSafe.java?rev=1037673&r1=1037672&r2=1037673&view=diff
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbSafe.java (original)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/KrbSafe.java Mon Nov 22 11:18:41 2010
@@ -39,13 +39,16 @@ import org.slf4j.LoggerFactory;
/**
+ * Class representing KRB-SAFE message
+ *
+ * <pre>
* KRB-SAFE ::= [APPLICATION 20] SEQUENCE {
* pvno [0] INTEGER (5),
* msg-type [1] INTEGER (20),
* safe-body [2] KRB-SAFE-BODY,
* cksum [3] Checksum
* }
- *
+ * </pre>
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class KrbSafe extends KerberosMessage
@@ -76,12 +79,52 @@ public class KrbSafe extends KerberosMes
*/
public KrbSafe()
{
- super( 5, KerberosMessageType.KRB_SAFE );
+ super( KerberosMessageType.KRB_SAFE );
}
/**
- * 0x14 L1 KRB-SAFE APPLICATION[20]
+ * @return the krbSafeBody
+ */
+ public KrbSafeBody getSafeBody()
+ {
+ return krbSafeBody;
+ }
+
+
+ /**
+ * @param safeBody the KrbSafeBody to set
+ */
+ public void setSafeBody( KrbSafeBody safeBody )
+ {
+ this.krbSafeBody = safeBody;
+ }
+
+
+ /**
+ * @return the checksum
+ */
+ public Checksum getChecksum()
+ {
+ return checksum;
+ }
+
+
+ /**
+ * @param checksum the checksum to set
+ */
+ public void setChecksum( Checksum checksum )
+ {
+ this.checksum = checksum;
+ }
+
+
+ /**
+ * Compute the KRB-SAFE length
+ * <pre>
+ * KRB-SAFE :
+ *
+ * 0x74 L1 KRB-SAFE APPLICATION[20]
* |
* +--> 0x30 L2 KRB-ERROR sequence
* |
@@ -95,11 +138,12 @@ public class KrbSafe extends KerberosMes
* |
* +--> 0xA2 L3 safe-body tag
* | |
- * | +--> 0x30 L3-1 safe-body (krb-safe-body)
+ * | +--> 0x30 L3-1 safe-body (KRB-SAFE-BODY)
* |
* +--> 0xA3 L4 cksum tag
* |
- * +--> 0x30 L4-1 cksum (checksum)
+ * +--> 0x30 L4-1 cksum (CHECKSUM)
+ * </pre>
*/
@Override
public int computeLength()
@@ -178,41 +222,33 @@ public class KrbSafe extends KerberosMes
return buffer;
}
+
+
/**
- * @return the krbSafeBody
+ * @see Object#toString()
*/
- public KrbSafeBody getSafeBody()
+ public String toString()
{
- return krbSafeBody;
- }
+ StringBuilder sb = new StringBuilder();
+ sb.append( "KRB-SAFE : {\n" );
+ sb.append( " pvno: " ).append( getProtocolVersionNumber() ).append( '\n' );
+ sb.append( " msgType: " ).append( getMessageType() ).append( '\n' );
- /**
- * @param safeBody the KrbSafeBody to set
- */
- public void setSafeBody( KrbSafeBody safeBody )
- {
- this.krbSafeBody = safeBody;
- }
-
+ if ( krbSafeBody != null )
+ {
+ sb.append( " safe-body: " ).append( krbSafeBody ).append( '\n' );
+ }
- /**
- * @return the checksum
- */
- public Checksum getChecksum()
- {
- return checksum;
- }
+ if ( checksum != null )
+ {
+ sb.append( " cusec: " ).append( checksum ).append( '\n' );
+ }
+ sb.append( "}\n" );
- /**
- * @param checksum the checksum to set
- */
- public void setChecksum( Checksum checksum )
- {
- this.checksum = checksum;
+ return sb.toString();
}
-
}