Return-Path: Delivered-To: apmail-directory-commits-archive@www.apache.org Received: (qmail 72424 invoked from network); 22 May 2007 00:01:42 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 22 May 2007 00:01:41 -0000 Received: (qmail 98534 invoked by uid 500); 22 May 2007 00:01:46 -0000 Delivered-To: apmail-directory-commits-archive@directory.apache.org Received: (qmail 98503 invoked by uid 500); 22 May 2007 00:01:46 -0000 Mailing-List: contact commits-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 98286 invoked by uid 99); 22 May 2007 00:01:45 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 21 May 2007 17:01:45 -0700 X-ASF-Spam-Status: No, hits=-99.5 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 21 May 2007 17:01:32 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id 4DC9A1A9823; Mon, 21 May 2007 17:01:12 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r540371 [3/7] - in /directory/apacheds/trunk: kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/crypto/checksum/ kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/crypto/encryption/ kerberos-s... Date: Tue, 22 May 2007 00:00:59 -0000 To: commits@directory.apache.org From: erodriguez@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20070522000112.4DC9A1A9823@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/TicketGrantReply.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/TicketGrantReply.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/TicketGrantReply.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/TicketGrantReply.java Mon May 21 17:00:43 2007 @@ -34,7 +34,7 @@ public class TicketGrantReply extends KdcReply { /** - * Class constructors + * Creates a new instance of TicketGrantReply. */ public TicketGrantReply() { @@ -42,8 +42,16 @@ } - public TicketGrantReply(PreAuthenticationData[] pAData, KerberosPrincipal clientPrincipal, Ticket ticket, - EncryptedData encPart) + /** + * Creates a new instance of TicketGrantReply. + * + * @param pAData + * @param clientPrincipal + * @param ticket + * @param encPart + */ + public TicketGrantReply( PreAuthenticationData[] pAData, KerberosPrincipal clientPrincipal, Ticket ticket, + EncryptedData encPart ) { super( pAData, clientPrincipal, ticket, encPart, MessageType.KRB_TGS_REP ); } Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/ApplicationReply.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/ApplicationReply.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/ApplicationReply.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/ApplicationReply.java Mon May 21 17:00:43 2007 @@ -34,13 +34,23 @@ private EncryptedData encryptedPart; - public ApplicationReply(EncryptedData encPart) + /** + * Creates a new instance of ApplicationReply. + * + * @param encPart + */ + public ApplicationReply( EncryptedData encPart ) { super( MessageType.KRB_AP_REP ); encryptedPart = encPart; } + /** + * Returns the {@link EncryptedData}. + * + * @return The {@link EncryptedData}. + */ public EncryptedData getEncPart() { return encryptedPart; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/CredentialMessage.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/CredentialMessage.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/CredentialMessage.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/CredentialMessage.java Mon May 21 17:00:43 2007 @@ -36,7 +36,13 @@ private Ticket[] tickets; - public CredentialMessage(EncryptedData encPart, Ticket[] tickets) + /** + * Creates a new instance of CredentialMessage. + * + * @param encPart + * @param tickets + */ + public CredentialMessage( EncryptedData encPart, Ticket[] tickets ) { super( MessageType.KRB_CRED ); this.encPart = encPart; @@ -44,12 +50,22 @@ } + /** + * Returns the {@link EncryptedData}. + * + * @return The {@link EncryptedData}. + */ public EncryptedData getEncPart() { return encPart; } + /** + * Returns an array of {@link Ticket}s. + * + * @return The array of {@link Ticket}s. + */ public Ticket[] getTickets() { return tickets; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/PrivateMessage.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/PrivateMessage.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/PrivateMessage.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/PrivateMessage.java Mon May 21 17:00:43 2007 @@ -34,6 +34,9 @@ private EncryptedData encryptedPart; + /** + * Creates a new instance of PrivateMessage. + */ public PrivateMessage() { super( MessageType.KRB_PRIV ); @@ -41,19 +44,34 @@ } - public PrivateMessage(EncryptedData encryptedPart) + /** + * Creates a new instance of PrivateMessage. + * + * @param encryptedPart + */ + public PrivateMessage( EncryptedData encryptedPart ) { super( MessageType.KRB_PRIV ); this.encryptedPart = encryptedPart; } + /** + * Returns the {@link EncryptedData}. + * + * @return The {@link EncryptedData}. + */ public EncryptedData getEncryptedPart() { return encryptedPart; } + /** + * Sets the {@link EncryptedData}. + * + * @param encryptedData + */ public void setEncryptedPart( EncryptedData encryptedData ) { encryptedPart = encryptedData; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/SafeBody.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/SafeBody.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/SafeBody.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/SafeBody.java Mon May 21 17:00:43 2007 @@ -39,10 +39,17 @@ /** - * Class constructor + * Creates a new instance of SafeBody. + * + * @param userData + * @param timestamp + * @param usec + * @param seqNumber + * @param sAddress + * @param rAddress */ - public SafeBody(byte[] userData, KerberosTime timestamp, Integer usec, Integer seqNumber, HostAddress sAddress, - HostAddress rAddress) + public SafeBody( byte[] userData, KerberosTime timestamp, Integer usec, Integer seqNumber, HostAddress sAddress, + HostAddress rAddress ) { this.userData = userData; this.timestamp = timestamp; @@ -53,36 +60,66 @@ } + /** + * Returns the "R" {@link HostAddress}. + * + * @return The "R" {@link HostAddress}. + */ public HostAddress getRAddress() { return rAddress; } + /** + * Returns the "S" {@link HostAddress}. + * + * @return The "S" {@link HostAddress}. + */ public HostAddress getSAddress() { return sAddress; } + /** + * Returns the sequence number. + * + * @return The sequence number. + */ public Integer getSeqNumber() { return seqNumber; } + /** + * Returns the {@link KerberosTime} timestamp. + * + * @return The {@link KerberosTime} timestamp. + */ public KerberosTime getTimestamp() { return timestamp; } + /** + * Returns the microsecond. + * + * @return The microsecond. + */ public Integer getUsec() { return usec; } + /** + * Returns the user data. + * + * @return The user data. + */ public byte[] getUserData() { return userData; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/SafeMessage.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/SafeMessage.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/SafeMessage.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/application/SafeMessage.java Mon May 21 17:00:43 2007 @@ -37,7 +37,13 @@ private Checksum cksum; - public SafeMessage(SafeBody safeBody, Checksum cksum) + /** + * Creates a new instance of SafeMessage. + * + * @param safeBody + * @param cksum + */ + public SafeMessage( SafeBody safeBody, Checksum cksum ) { super( MessageType.KRB_SAFE ); this.safeBody = safeBody; @@ -45,6 +51,11 @@ } + /** + * Returns the {@link Checksum}. + * + * @return The {@link Checksum}. + */ public Checksum getCksum() { return cksum; @@ -52,36 +63,67 @@ // SafeBody delegate methods + + /** + * Returns the "R" {@link HostAddress}. + * + * @return The "R" {@link HostAddress}. + */ public HostAddress getRAddress() { return safeBody.getRAddress(); } + /** + * Returns the "S" {@link HostAddress}. + * + * @return The "S" {@link HostAddress}. + */ public HostAddress getSAddress() { return safeBody.getSAddress(); } + /** + * Returns the sequence number. + * + * @return The sequence number. + */ public Integer getSeqNumber() { return safeBody.getSeqNumber(); } + /** + * Returns the {@link KerberosTime} timestamp. + * + * @return The {@link KerberosTime} timestamp. + */ public KerberosTime getTimestamp() { return safeBody.getTimestamp(); } + /** + * Returns the microsecond. + * + * @return The microsecond. + */ public Integer getUsec() { return safeBody.getUsec(); } + /** + * Returns the user data. + * + * @return The user data. + */ public byte[] getUserData() { return safeBody.getUserData(); Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/Authenticator.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/Authenticator.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/Authenticator.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/Authenticator.java Mon May 21 17:00:43 2007 @@ -35,6 +35,9 @@ */ public class Authenticator implements Encodable { + /** + * Constant for the authenticator version number. + */ public static final int AUTHENTICATOR_VNO = 5; private int versionNumber; @@ -47,17 +50,40 @@ private AuthorizationData authorizationData; - public Authenticator(KerberosPrincipal clientPrincipal, Checksum checksum, int clientMicroSecond, - KerberosTime clientTime, EncryptionKey subSessionKey, int sequenceNumber, AuthorizationData authorizationData) + /** + * Creates a new instance of Authenticator. + * + * @param clientPrincipal + * @param checksum + * @param clientMicroSecond + * @param clientTime + * @param subSessionKey + * @param sequenceNumber + * @param authorizationData + */ + public Authenticator( KerberosPrincipal clientPrincipal, Checksum checksum, int clientMicroSecond, + KerberosTime clientTime, EncryptionKey subSessionKey, int sequenceNumber, AuthorizationData authorizationData ) { this( AUTHENTICATOR_VNO, clientPrincipal, checksum, clientMicroSecond, clientTime, subSessionKey, sequenceNumber, authorizationData ); } - public Authenticator(int versionNumber, KerberosPrincipal clientPrincipal, Checksum checksum, + /** + * Creates a new instance of Authenticator. + * + * @param versionNumber + * @param clientPrincipal + * @param checksum + * @param clientMicroSecond + * @param clientTime + * @param subSessionKey + * @param sequenceNumber + * @param authorizationData + */ + public Authenticator( int versionNumber, KerberosPrincipal clientPrincipal, Checksum checksum, int clientMicroSecond, KerberosTime clientTime, EncryptionKey subSessionKey, int sequenceNumber, - AuthorizationData authorizationData) + AuthorizationData authorizationData ) { this.versionNumber = versionNumber; this.clientPrincipal = clientPrincipal; @@ -70,48 +96,88 @@ } + /** + * Returns the client {@link KerberosPrincipal}. + * + * @return The client {@link KerberosPrincipal}. + */ public KerberosPrincipal getClientPrincipal() { return clientPrincipal; } + /** + * Returns the client {@link KerberosTime}. + * + * @return The client {@link KerberosTime}. + */ public KerberosTime getClientTime() { return clientTime; } + /** + * Returns the client microsecond. + * + * @return The client microsecond. + */ public int getClientMicroSecond() { return clientMicroSecond; } + /** + * Returns the {@link AuthorizationData}. + * + * @return The {@link AuthorizationData}. + */ public AuthorizationData getAuthorizationData() { return authorizationData; } + /** + * Returns the {@link Checksum}. + * + * @return The {@link Checksum}. + */ public Checksum getChecksum() { return checksum; } + /** + * Returns the sequence number. + * + * @return The sequence number. + */ public int getSequenceNumber() { return sequenceNumber; } + /** + * Returns the sub-session key. + * + * @return The sub-session key. + */ public EncryptionKey getSubSessionKey() { return subSessionKey; } + /** + * Returns the version number of the {@link Authenticator}. + * + * @return The version number of the {@link Authenticator}. + */ public int getVersionNumber() { return versionNumber; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/AuthenticatorModifier.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/AuthenticatorModifier.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/AuthenticatorModifier.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/AuthenticatorModifier.java Mon May 21 17:00:43 2007 @@ -46,9 +46,13 @@ private AuthorizationData authorizationData; + /** + * Returns the {@link Authenticator}. + * + * @return The {@link Authenticator}. + */ public Authenticator getAuthenticator() { - KerberosPrincipal clientPrincipal = clientModifier.getKerberosPrincipal(); return new Authenticator( versionNumber, clientPrincipal, checksum, clientMicroSecond, clientTime, @@ -56,54 +60,99 @@ } + /** + * Sets the version number. + * + * @param versionNumber + */ public void setVersionNumber( int versionNumber ) { this.versionNumber = versionNumber; } + /** + * Sets the client {@link PrincipalName}. + * + * @param name + */ public void setClientName( PrincipalName name ) { clientModifier.setPrincipalName( name ); } + /** + * Sets the client realm. + * + * @param realm + */ public void setClientRealm( String realm ) { clientModifier.setRealm( realm ); } + /** + * Sets the {@link AuthorizationData}. + * + * @param data + */ public void setAuthorizationData( AuthorizationData data ) { authorizationData = data; } + /** + * Sets the {@link Checksum}. + * + * @param checksum + */ public void setChecksum( Checksum checksum ) { this.checksum = checksum; } + /** + * Sets the client microsecond. + * + * @param microSecond + */ public void setClientMicroSecond( int microSecond ) { clientMicroSecond = microSecond; } + /** + * Sets the client {@link KerberosTime}. + * + * @param time + */ public void setClientTime( KerberosTime time ) { clientTime = time; } + /** + * Sets the sequence number. + * + * @param number + */ public void setSequenceNumber( int number ) { sequenceNumber = number; } + /** + * Sets the sub-session {@link EncryptionKey}. + * + * @param sessionKey + */ public void setSubSessionKey( EncryptionKey sessionKey ) { subSessionKey = sessionKey; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncApRepPart.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncApRepPart.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncApRepPart.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncApRepPart.java Mon May 21 17:00:43 2007 @@ -41,7 +41,15 @@ private Integer sequenceNumber; //optional - public EncApRepPart(KerberosTime clientTime, int cusec, EncryptionKey subSessionKey, Integer sequenceNumber) + /** + * Creates a new instance of EncApRepPart. + * + * @param clientTime + * @param cusec + * @param subSessionKey + * @param sequenceNumber + */ + public EncApRepPart( KerberosTime clientTime, int cusec, EncryptionKey subSessionKey, Integer sequenceNumber ) { super( MessageType.ENC_AP_REP_PART ); @@ -52,24 +60,44 @@ } + /** + * Returns the client {@link KerberosTime}. + * + * @return The client {@link KerberosTime}. + */ public KerberosTime getClientTime() { return clientTime; } + /** + * Returns the client microsecond. + * + * @return The client microsecond. + */ public int getClientMicroSecond() { return cusec; } + /** + * Returns the sequence number. + * + * @return The sequence number. + */ public Integer getSequenceNumber() { return sequenceNumber; } + /** + * Returns the sub-session {@link EncryptionKey}. + * + * @return The sub-session {@link EncryptionKey}. + */ public EncryptionKey getSubSessionKey() { return subSessionKey; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncApRepPartModifier.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncApRepPartModifier.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncApRepPartModifier.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncApRepPartModifier.java Mon May 21 17:00:43 2007 @@ -36,30 +36,55 @@ private Integer sequenceNumber; //optional + /** + * Returns the {@link EncApRepPart}. + * + * @return The {@link EncApRepPart}. + */ public EncApRepPart getEncApRepPart() { return new EncApRepPart( clientTime, cusec, subSessionKey, sequenceNumber ); } + /** + * Sets the client {@link KerberosTime}. + * + * @param clientTime + */ public void setClientTime( KerberosTime clientTime ) { this.clientTime = clientTime; } + /** + * Sets the client microsecond. + * + * @param cusec + */ public void setClientMicroSecond( int cusec ) { this.cusec = cusec; } + /** + * Sets the sub-session {@link EncryptionKey}. + * + * @param subSessionKey + */ public void setSubSessionKey( EncryptionKey subSessionKey ) { this.subSessionKey = subSessionKey; } + /** + * Sets the sequence number. + * + * @param sequenceNumber + */ public void setSequenceNumber( Integer sequenceNumber ) { this.sequenceNumber = sequenceNumber; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncAsRepPart.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncAsRepPart.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncAsRepPart.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncAsRepPart.java Mon May 21 17:00:43 2007 @@ -38,7 +38,19 @@ public class EncAsRepPart extends EncKdcRepPart { /** - * Class constructor + * Creates a new instance of EncAsRepPart. + * + * @param key + * @param lastReq + * @param nonce + * @param keyExpiration + * @param flags + * @param authTime + * @param startTime + * @param endTime + * @param renewTill + * @param serverPrincipal + * @param caddr */ public EncAsRepPart(EncryptionKey key, LastRequest lastReq, int nonce, KerberosTime keyExpiration, TicketFlags flags, KerberosTime authTime, KerberosTime startTime, KerberosTime endTime, KerberosTime renewTill, Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKdcRepPart.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKdcRepPart.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKdcRepPart.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKdcRepPart.java Mon May 21 17:00:43 2007 @@ -52,7 +52,7 @@ /** - * Class constructors + * Creates a new instance of EncKdcRepPart. */ public EncKdcRepPart() { @@ -60,9 +60,25 @@ } - public EncKdcRepPart(EncryptionKey key, LastRequest lastReq, int nonce, KerberosTime keyExpiration, + /** + * Creates a new instance of EncKdcRepPart. + * + * @param key + * @param lastReq + * @param nonce + * @param keyExpiration + * @param flags + * @param authtime + * @param starttime + * @param endtime + * @param renewTill + * @param serverPrincipal + * @param caddr + * @param componentType + */ + public EncKdcRepPart( EncryptionKey key, LastRequest lastReq, int nonce, KerberosTime keyExpiration, TicketFlags flags, KerberosTime authtime, KerberosTime starttime, KerberosTime endtime, KerberosTime renewTill, - KerberosPrincipal serverPrincipal, HostAddresses caddr, MessageComponentType componentType) + KerberosPrincipal serverPrincipal, HostAddresses caddr, MessageComponentType componentType ) { this.key = key; this.lastRequest = lastReq; @@ -79,146 +95,264 @@ } - // getters + /** + * Returns the auth {@link KerberosTime}. + * + * @return The auth {@link KerberosTime}. + */ public KerberosTime getAuthTime() { return authTime; } + /** + * Returns the client {@link HostAddresses}. + * + * @return The client {@link HostAddresses}. + */ public HostAddresses getClientAddresses() { return clientAddresses; } + /** + * Returns the end {@link KerberosTime}. + * + * @return The end {@link KerberosTime}. + */ public KerberosTime getEndTime() { return endTime; } + /** + * Returns the {@link TicketFlags}. + * + * @return The {@link TicketFlags}. + */ public TicketFlags getFlags() { return flags; } + /** + * Returns the {@link EncryptionKey}. + * + * @return The {@link EncryptionKey}. + */ public EncryptionKey getKey() { return key; } + /** + * Returns the key expiration {@link KerberosTime}. + * + * @return The key expiration {@link KerberosTime}. + */ public KerberosTime getKeyExpiration() { return keyExpiration; } + /** + * Returns the {@link LastRequest}. + * + * @return The {@link LastRequest}. + */ public LastRequest getLastRequest() { return lastRequest; } + /** + * Returns the nonce. + * + * @return The nonce. + */ public int getNonce() { return nonce; } + /** + * Returns the renew till {@link KerberosTime}. + * + * @return The renew till {@link KerberosTime}. + */ public KerberosTime getRenewTill() { return renewTill; } + /** + * Returns the server {@link KerberosPrincipal}. + * + * @return The server {@link KerberosPrincipal}. + */ public KerberosPrincipal getServerPrincipal() { return serverPrincipal; } + /** + * Returns the server realm. + * + * @return The server realm. + */ public String getServerRealm() { return serverPrincipal.getRealm(); } + /** + * Returns the start {@link KerberosTime}. + * + * @return The start {@link KerberosTime}. + */ public KerberosTime getStartTime() { return startTime; } + /** + * Returns the {@link MessageComponentType}. + * + * @return The {@link MessageComponentType}. + */ public MessageComponentType getComponentType() { return componentType; } - // setters + /** + * Sets the auth {@link KerberosTime}. + * + * @param time + */ public void setAuthTime( KerberosTime time ) { authTime = time; } + /** + * Sets the client {@link HostAddresses}. + * + * @param addresses + */ public void setClientAddresses( HostAddresses addresses ) { clientAddresses = addresses; } + /** + * Sets the end {@link KerberosTime}. + * + * @param time + */ public void setEndTime( KerberosTime time ) { endTime = time; } + /** + * Sets the {@link TicketFlags}. + * + * @param flags + */ public void setFlags( TicketFlags flags ) { this.flags = flags; } + /** + * Sets the {@link EncryptionKey}. + * + * @param key + */ public void setKey( EncryptionKey key ) { this.key = key; } + /** + * Sets the key expiration {@link KerberosTime}. + * + * @param expiration + */ public void setKeyExpiration( KerberosTime expiration ) { keyExpiration = expiration; } + /** + * Sets the {@link LastRequest}. + * + * @param request + */ public void setLastRequest( LastRequest request ) { lastRequest = request; } + /** + * Sets the nonce. + * + * @param nonce + */ public void setNonce( int nonce ) { this.nonce = nonce; } + /** + * Sets the renew till {@link KerberosTime}. + * + * @param till + */ public void setRenewTill( KerberosTime till ) { renewTill = till; } + /** + * Sets the server {@link KerberosPrincipal}. + * + * @param principal + */ public void setServerPrincipal( KerberosPrincipal principal ) { serverPrincipal = principal; } + /** + * Sets the start {@link KerberosTime}. + * + * @param time + */ public void setStartTime( KerberosTime time ) { startTime = time; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbCredPart.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbCredPart.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbCredPart.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbCredPart.java Mon May 21 17:00:43 2007 @@ -34,19 +34,26 @@ */ public class EncKrbCredPart { - public KrbCredInfo[] ticketInfo; - public Integer nonce; //optional - public KerberosTime timeStamp; //optional - public Integer usec; //optional - public HostAddress sAddress; //optional - public HostAddresses rAddress; //optional + private KrbCredInfo[] ticketInfo; + private Integer nonce; //optional + private KerberosTime timeStamp; //optional + private Integer usec; //optional + private HostAddress sAddress; //optional + private HostAddresses rAddress; //optional /** - * Class constructor + * Creates a new instance of EncKrbCredPart. + * + * @param ticketInfo + * @param timeStamp + * @param usec + * @param nonce + * @param sAddress + * @param rAddress */ - public EncKrbCredPart(KrbCredInfo[] ticketInfo, KerberosTime timeStamp, Integer usec, Integer nonce, - HostAddress sAddress, HostAddresses rAddress) + public EncKrbCredPart( KrbCredInfo[] ticketInfo, KerberosTime timeStamp, Integer usec, Integer nonce, + HostAddress sAddress, HostAddresses rAddress ) { this.ticketInfo = ticketInfo; this.nonce = nonce; @@ -54,5 +61,71 @@ this.usec = usec; this.sAddress = sAddress; this.rAddress = rAddress; + } + + + /** + * Returns the nonce. + * + * @return The nonce. + */ + public Integer getNonce() + { + return nonce; + } + + + /** + * Returns the "R" {@link HostAddresses}. + * + * @return The "R" {@link HostAddresses}. + */ + public HostAddresses getRAddress() + { + return rAddress; + } + + + /** + * Returns the "S" {@link HostAddresses}. + * + * @return The "S" {@link HostAddresses}. + */ + public HostAddress getSAddress() + { + return sAddress; + } + + + /** + * Returns the {@link KrbCredInfo}s. + * + * @return The {@link KrbCredInfo}s. + */ + public KrbCredInfo[] getTicketInfo() + { + return ticketInfo; + } + + + /** + * Returns the timestamp. + * + * @return The timeStamp. + */ + public KerberosTime getTimeStamp() + { + return timeStamp; + } + + + /** + * Returns the microseconds. + * + * @return The microseconds. + */ + public Integer getUsec() + { + return usec; } } Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbPrivPart.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbPrivPart.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbPrivPart.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbPrivPart.java Mon May 21 17:00:43 2007 @@ -43,8 +43,18 @@ private HostAddress recipientAddress; //optional - public EncKrbPrivPart(byte[] userData, KerberosTime timestamp, Integer usec, Integer sequenceNumber, - HostAddress senderAddress, HostAddress recipientAddress) + /** + * Creates a new instance of EncKrbPrivPart. + * + * @param userData + * @param timestamp + * @param usec + * @param sequenceNumber + * @param senderAddress + * @param recipientAddress + */ + public EncKrbPrivPart( byte[] userData, KerberosTime timestamp, Integer usec, Integer sequenceNumber, + HostAddress senderAddress, HostAddress recipientAddress ) { super( MessageType.ENC_PRIV_PART ); @@ -57,36 +67,66 @@ } + /** + * Returns the recipient {@link HostAddress}. + * + * @return The recipient {@link HostAddress}. + */ public HostAddress getRecipientAddress() { return recipientAddress; } + /** + * Returns the sender {@link HostAddress}. + * + * @return The sender {@link HostAddress}. + */ public HostAddress getSenderAddress() { return senderAddress; } + /** + * Returns the sequence number. + * + * @return The sequence number. + */ public Integer getSequenceNumber() { return sequenceNumber; } + /** + * Returns the {@link KerberosTime} timestamp. + * + * @return The {@link KerberosTime} timestamp. + */ public KerberosTime getTimestamp() { return timestamp; } + /** + * Returns the microsecond. + * + * @return The microsecond. + */ public Integer getMicroSecond() { return usec; } + /** + * Returns the user data. + * + * @return The user data. + */ public byte[] getUserData() { return userData; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbPrivPartModifier.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbPrivPartModifier.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbPrivPartModifier.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncKrbPrivPartModifier.java Mon May 21 17:00:43 2007 @@ -38,42 +38,77 @@ private HostAddress recipientAddress; //optional + /** + * Returns the {@link EncKrbPrivPart}. + * + * @return The {@link EncKrbPrivPart}. + */ public EncKrbPrivPart getEncKrbPrivPart() { return new EncKrbPrivPart( userData, timestamp, usec, sequenceNumber, senderAddress, recipientAddress ); } + /** + * Sets the recipient {@link HostAddress}. + * + * @param address + */ public void setRecipientAddress( HostAddress address ) { recipientAddress = address; } + /** + * Sets the sender {@link HostAddress}. + * + * @param address + */ public void setSenderAddress( HostAddress address ) { senderAddress = address; } + /** + * Sets the sequence number. + * + * @param number + */ public void setSequenceNumber( Integer number ) { sequenceNumber = number; } + /** + * Sets the {@link KerberosTime} timestamp. + * + * @param timestamp + */ public void setTimestamp( KerberosTime timestamp ) { this.timestamp = timestamp; } + /** + * Sets the microsecond. + * + * @param usec + */ public void setMicroSecond( Integer usec ) { this.usec = usec; } + /** + * Sets the user data. + * + * @param data + */ public void setUserData( byte[] data ) { userData = data; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTgsRepPart.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTgsRepPart.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTgsRepPart.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTgsRepPart.java Mon May 21 17:00:43 2007 @@ -38,13 +38,24 @@ public class EncTgsRepPart extends EncKdcRepPart { /** - * Class constructor + * Creates a new instance of EncTgsRepPart. + * + * @param key + * @param lastReq + * @param nonce + * @param keyExpiration + * @param flags + * @param authtime + * @param starttime + * @param endtime + * @param renewTill + * @param serverPrincipal + * @param caddr */ public EncTgsRepPart(EncryptionKey key, LastRequest lastReq, int nonce, KerberosTime keyExpiration, TicketFlags flags, KerberosTime authtime, KerberosTime starttime, KerberosTime endtime, KerberosTime renewTill, KerberosPrincipal serverPrincipal, HostAddresses caddr) { - super( key, lastReq, nonce, keyExpiration, flags, authtime, starttime, endtime, renewTill, serverPrincipal, caddr, MessageComponentType.KRB_ENC_TGS_REP_PART ); } Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTicketPart.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTicketPart.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTicketPart.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTicketPart.java Mon May 21 17:00:43 2007 @@ -51,11 +51,24 @@ private AuthorizationData authorizationData; //optional - public EncTicketPart(TicketFlags flags, EncryptionKey key, KerberosPrincipal clientPrincipal, + /** + * Creates a new instance of EncTicketPart. + * + * @param flags + * @param key + * @param clientPrincipal + * @param transited + * @param authtime + * @param starttime + * @param endtime + * @param renewTill + * @param caddr + * @param authorizationData + */ + public EncTicketPart( TicketFlags flags, EncryptionKey key, KerberosPrincipal clientPrincipal, TransitedEncoding transited, KerberosTime authtime, KerberosTime starttime, KerberosTime endtime, - KerberosTime renewTill, HostAddresses caddr, AuthorizationData authorizationData) + KerberosTime renewTill, HostAddresses caddr, AuthorizationData authorizationData ) { - this.flags = flags; this.sessionKey = key; this.clientPrincipal = clientPrincipal; @@ -69,66 +82,121 @@ } + /** + * Returns the {@link AuthorizationData}. + * + * @return The {@link AuthorizationData}. + */ public AuthorizationData getAuthorizationData() { return authorizationData; } + /** + * Returns the auth {@link KerberosTime} + * + * @return The auth {@link KerberosTime} + */ public KerberosTime getAuthTime() { return authtime; } + /** + * Returns the client {@link HostAddresses}. + * + * @return The client {@link HostAddresses}. + */ public HostAddresses getClientAddresses() { return clientAddresses; } + /** + * Returns the client {@link KerberosPrincipal}. + * + * @return The client {@link KerberosPrincipal}. + */ public KerberosPrincipal getClientPrincipal() { return clientPrincipal; } + /** + * Returns the client realm. + * + * @return The client realm. + */ public String getClientRealm() { return clientPrincipal.getRealm(); } + /** + * Returns the end {@link KerberosTime} + * + * @return The end {@link KerberosTime} + */ public KerberosTime getEndTime() { return endTime; } + /** + * Returns the {@link TicketFlags}. + * + * @return The {@link TicketFlags}. + */ public TicketFlags getFlags() { return flags; } + /** + * Returns the session {@link EncryptionKey}. + * + * @return The session {@link EncryptionKey}. + */ public EncryptionKey getSessionKey() { return sessionKey; } + /** + * Returns the renew till {@link KerberosTime} + * + * @return The renew till {@link KerberosTime} + */ public KerberosTime getRenewTill() { return renewTill; } + /** + * Returns the start {@link KerberosTime} + * + * @return The start {@link KerberosTime} + */ public KerberosTime getStartTime() { return startTime; } + /** + * Returns the {@link TransitedEncoding}. + * + * @return The {@link TransitedEncoding}. + */ public TransitedEncoding getTransitedEncoding() { return transitedEncoding; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTicketPartModifier.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTicketPartModifier.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTicketPartModifier.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/EncTicketPartModifier.java Mon May 21 17:00:43 2007 @@ -53,6 +53,11 @@ private AuthorizationData authorizationData; //optional + /** + * Returns the {@link EncTicketPart}. + * + * @return The {@link EncTicketPart}. + */ public EncTicketPart getEncTicketPart() { if ( clientPrincipal == null ) @@ -65,84 +70,154 @@ } + /** + * Sets the client {@link PrincipalName}. + * + * @param name + */ public void setClientName( PrincipalName name ) { modifier.setPrincipalName( name ); } + /** + * Sets the client realm. + * + * @param realm + */ public void setClientRealm( String realm ) { modifier.setRealm( realm ); } + /** + * Sets the client {@link KerberosPrincipal}. + * + * @param principal + */ public void setClientPrincipal( KerberosPrincipal principal ) { clientPrincipal = principal; } + /** + * Sets the {@link AuthorizationData}. + * + * @param data + */ public void setAuthorizationData( AuthorizationData data ) { authorizationData = data; } + /** + * Sets the auth {@link KerberosTime}. + * + * @param authtime + */ public void setAuthTime( KerberosTime authtime ) { authTime = authtime; } + /** + * Sets the client {@link HostAddresses}. + * + * @param addresses + */ public void setClientAddresses( HostAddresses addresses ) { clientAddresses = addresses; } + /** + * Sets the end {@link KerberosTime}. + * + * @param time + */ public void setEndTime( KerberosTime time ) { endTime = time; } + /** + * Sets the {@link TicketFlags}. + * + * @param flags + */ public void setFlags( TicketFlags flags ) { this.flags = flags; } + /** + * Sets the flag at the given index. + * + * @param flag + */ public void setFlag( int flag ) { flags.set( flag ); } + /** + * Clears the flag at the given index. + * + * @param flag + */ public void clearFlag( int flag ) { flags.clear( flag ); } + /** + * Sets the renew till {@link KerberosTime}. + * + * @param till + */ public void setRenewTill( KerberosTime till ) { renewTill = till; } + /** + * Sets the sesson {@link EncryptionKey}. + * + * @param key + */ public void setSessionKey( EncryptionKey key ) { sessionKey = key; } + /** + * Sets the start {@link KerberosTime}. + * + * @param time + */ public void setStartTime( KerberosTime time ) { startTime = time; } + /** + * Sets the {@link TransitedEncoding}. + * + * @param encoding + */ public void setTransitedEncoding( TransitedEncoding encoding ) { transitedEncoding = encoding; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/MessageComponentType.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/MessageComponentType.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/MessageComponentType.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/MessageComponentType.java Mon May 21 17:00:43 2007 @@ -34,47 +34,94 @@ public class MessageComponentType implements Comparable { /** - * Enumeration elements are constructed once upon class loading. - * Order of appearance here determines the order of compareTo. + * Constant for the "null" message component type. */ public static final MessageComponentType NULL = new MessageComponentType( 0, "null" ); + + /** + * Constant for the "ticket" message component type. + */ public static final MessageComponentType KRB_TKT = new MessageComponentType( 1, "ticket" ); + + /** + * Constant for the "authenticator" message component type. + */ public static final MessageComponentType KRB_AUTHENTICATOR = new MessageComponentType( 2, "authenticator" ); + + /** + * Constant for the "encrypted ticket part" message component type. + */ public static final MessageComponentType KRB_ENC_TKT_PART = new MessageComponentType( 3, "encrypted ticket part" ); + + /** + * Constant for the "encrypted initial authentication part" message component type. + */ public static final MessageComponentType KRB_ENC_AS_REP_PART = new MessageComponentType( 25, "encrypted initial authentication part" ); + + /** + * Constant for the "encrypted TGS request part" message component type. + */ public static final MessageComponentType KRB_ENC_TGS_REP_PART = new MessageComponentType( 26, "encrypted TGS request part" ); + + /** + * Constant for the "encrypted application request part" message component type. + */ public static final MessageComponentType KRB_ENC_AP_REP_PART = new MessageComponentType( 27, "encrypted application request part" ); + + /** + * Constant for the "encrypted application message part" message component type. + */ public static final MessageComponentType KRB_ENC_KRB_PRIV_PART = new MessageComponentType( 28, "encrypted application message part" ); + + /** + * Constant for the "encrypted credentials forward part" message component type. + */ public static final MessageComponentType KRB_ENC_KRB_CRED_PART = new MessageComponentType( 29, "encrypted credentials forward part" ); /** - * These two lines are all that's necessary to export a List of VALUES. + * Array for building a List of VALUES. */ private static final MessageComponentType[] values = { NULL, KRB_TKT, KRB_AUTHENTICATOR, KRB_ENC_TKT_PART, KRB_ENC_AS_REP_PART, KRB_ENC_TGS_REP_PART, KRB_ENC_AP_REP_PART, KRB_ENC_KRB_PRIV_PART, KRB_ENC_KRB_CRED_PART }; + /** + * A List of all the message component type constants. + */ public static final List VALUES = Collections.unmodifiableList( Arrays.asList( values ) ); + /** + * The name of the message component type. + */ private final String name; + + /** + * The value/code for the message component type. + */ private final int ordinal; /** * Private constructor prevents construction outside of this class. */ - private MessageComponentType(int ordinal, String name) + private MessageComponentType( int ordinal, String name ) { this.ordinal = ordinal; this.name = name; } + /** + * Returns the message component type when specified by its ordinal. + * + * @param type + * @return The message component type. + */ public static MessageComponentType getTypeByOrdinal( int type ) { for ( int ii = 0; ii < values.length; ii++ ) @@ -89,20 +136,25 @@ } + /** + * Returns the number associated with this message component type. + * + * @return The message component type ordinal. + */ public int getOrdinal() { return ordinal; } - public String toString() + public int compareTo( Object that ) { - return name + " (" + ordinal + ")"; + return ordinal - ( ( MessageComponentType ) that ).ordinal; } - public int compareTo( Object that ) + public String toString() { - return ordinal - ( ( MessageComponentType ) that ).ordinal; + return name + " (" + ordinal + ")"; } } Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/Ticket.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/Ticket.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/Ticket.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/Ticket.java Mon May 21 17:00:43 2007 @@ -39,6 +39,9 @@ */ public class Ticket { + /** + * Constant for the {@link Ticket} version number (5). + */ public static final int TICKET_VNO = 5; private int versionNumber; @@ -47,13 +50,26 @@ private EncTicketPart encTicketPart; - public Ticket(KerberosPrincipal serverPrincipal, EncryptedData encPart) + /** + * Creates a new instance of Ticket. + * + * @param serverPrincipal + * @param encPart + */ + public Ticket( KerberosPrincipal serverPrincipal, EncryptedData encPart ) { this( TICKET_VNO, serverPrincipal, encPart ); } - public Ticket(int versionNumber, KerberosPrincipal serverPrincipal, EncryptedData encPart) + /** + * Creates a new instance of Ticket. + * + * @param versionNumber + * @param serverPrincipal + * @param encPart + */ + public Ticket( int versionNumber, KerberosPrincipal serverPrincipal, EncryptedData encPart ) { this.versionNumber = versionNumber; this.serverPrincipal = serverPrincipal; @@ -61,111 +77,199 @@ } + /** + * Sets the {@link EncTicketPart}. + * + * @param decryptedPart + */ public void setEncTicketPart( EncTicketPart decryptedPart ) { encTicketPart = decryptedPart; } - // getters + /** + * Returns the version number. + * + * @return The version number. + */ public int getVersionNumber() { return versionNumber; } + /** + * Returns the server {@link KerberosPrincipal}. + * + * @return The server {@link KerberosPrincipal}. + */ public KerberosPrincipal getServerPrincipal() { return serverPrincipal; } + /** + * Returns the server realm. + * + * @return The server realm. + */ public String getRealm() { return serverPrincipal.getRealm(); } + /** + * Returns the {@link EncryptedData}. + * + * @return The {@link EncryptedData}. + */ public EncryptedData getEncPart() { return encPart; } + /** + * Returns the {@link EncTicketPart}. + * + * @return The {@link EncTicketPart}. + */ public EncTicketPart getEncTicketPart() { return encTicketPart; } - // EncTicketPart delegate getters + /** + * Returns the {@link AuthorizationData}. + * + * @return The {@link AuthorizationData}. + */ public AuthorizationData getAuthorizationData() { return encTicketPart.getAuthorizationData(); } + /** + * Returns the auth {@link KerberosTime}. + * + * @return The auth {@link KerberosTime}. + */ public KerberosTime getAuthTime() { return encTicketPart.getAuthTime(); } + /** + * Returns the client {@link HostAddresses}. + * + * @return The client {@link HostAddresses}. + */ public HostAddresses getClientAddresses() { return encTicketPart.getClientAddresses(); } + /** + * Returns the client {@link KerberosPrincipal}. + * + * @return The client {@link KerberosPrincipal}. + */ public KerberosPrincipal getClientPrincipal() { return encTicketPart.getClientPrincipal(); } + /** + * Returns the client realm. + * + * @return The client realm. + */ public String getClientRealm() { return encTicketPart.getClientPrincipal().getRealm(); } + /** + * Returns the end {@link KerberosTime}. + * + * @return The end {@link KerberosTime}. + */ public KerberosTime getEndTime() { return encTicketPart.getEndTime(); } + /** + * Returns the {@link TicketFlags}. + * + * @return The {@link TicketFlags}. + */ public TicketFlags getFlags() { return encTicketPart.getFlags(); } + /** + * Returns the renew till {@link KerberosTime}. + * + * @return The renew till {@link KerberosTime}. + */ public KerberosTime getRenewTill() { return encTicketPart.getRenewTill(); } + /** + * Returns the session {@link EncryptionKey}. + * + * @return The session {@link EncryptionKey}. + */ public EncryptionKey getSessionKey() { return encTicketPart.getSessionKey(); } + /** + * Returns the start {@link KerberosTime}. + * + * @return The start {@link KerberosTime}. + */ public KerberosTime getStartTime() { return encTicketPart.getStartTime(); } + /** + * Returns the {@link TransitedEncoding}. + * + * @return The {@link TransitedEncoding}. + */ public TransitedEncoding getTransitedEncoding() { return encTicketPart.getTransitedEncoding(); } - // EncTicketPart TicketFlag delegates + /** + * Returns the flag at the given index. + * + * @param flag + * @return true if the flag at the given index is set. + */ public boolean getFlag( int flag ) { return encTicketPart.getFlags().get( flag ); Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/TicketModifier.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/TicketModifier.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/TicketModifier.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/components/TicketModifier.java Mon May 21 17:00:43 2007 @@ -38,6 +38,11 @@ private EncryptedData encPart; + /** + * Returns the {@link Ticket}. + * + * @return The {@link Ticket}. + */ public Ticket getTicket() { KerberosPrincipal serverPrincipal = serverModifier.getKerberosPrincipal(); @@ -45,24 +50,44 @@ } + /** + * Sets the {@link Ticket} version number. + * + * @param versionNumber + */ public void setTicketVersionNumber( int versionNumber ) { ticketVersionNumber = versionNumber; } + /** + * Sets the {@link EncryptedData}. + * + * @param part + */ public void setEncPart( EncryptedData part ) { encPart = part; } + /** + * Sets the server {@link PrincipalName}. + * + * @param name + */ public void setServerName( PrincipalName name ) { serverModifier.setPrincipalName( name ); } + /** + * Sets the server realm. + * + * @param realm + */ public void setServerRealm( String realm ) { serverModifier.setRealm( realm ); Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/ApOptions.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/ApOptions.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/ApOptions.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/ApOptions.java Mon May 21 17:00:43 2007 @@ -26,19 +26,29 @@ */ public class ApOptions extends Options { - // AP Request option - reserved + /** + * AP Request option - reserved + */ public static final int RESERVED = 0; - // AP Request option - use session key + + /** + * AP Request option - use session key + */ public static final int USE_SESSION_KEY = 1; - // AP Request option - mutual authentication required + + /** + * AP Request option - mutual authentication required + */ public static final int MUTUAL_REQUIRED = 2; - // AP Request option - maximum value + /** + * AP Request option - maximum value + */ public static final int MAX_VALUE = 32; /** - * Class constructors + * Creates a new instance of ApOptions. */ public ApOptions() { @@ -46,7 +56,12 @@ } - public ApOptions(byte[] options) + /** + * Creates a new instance of ApOptions. + * + * @param options + */ + public ApOptions( byte[] options ) { super( MAX_VALUE ); setBytes( options ); @@ -54,7 +69,7 @@ /** - * Converts the object to a printable string + * Converts the object to a printable string. */ public String toString() { Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationData.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationData.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationData.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationData.java Mon May 21 17:00:43 2007 @@ -33,11 +33,11 @@ */ public class AuthorizationData implements Encodable { - private List entries = new ArrayList(); + private List entries = new ArrayList(); /** - * Class constructor + * Creates a new instance of AuthorizationData. */ public AuthorizationData() { @@ -45,18 +45,33 @@ } + /** + * Adds all {@link AuthorizationData} entries to this {@link AuthorizationData}. + * + * @param data + */ public void add( AuthorizationData data ) { entries.addAll( data.entries ); } + /** + * Adds an {@link AuthorizationDataEntry} to this {@link AuthorizationData}. + * + * @param entry + */ public void add( AuthorizationDataEntry entry ) { entries.add( entry ); } + /** + * Returns an {@link Iterator} over the entries in this {@link AuthorizationData}. + * + * @return An {@link Iterator} over the entries in this {@link AuthorizationData}. + */ public Iterator iterator() { return entries.iterator(); Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationDataEntry.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationDataEntry.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationDataEntry.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationDataEntry.java Mon May 21 17:00:43 2007 @@ -31,21 +31,34 @@ /** - * Class constructor + * Creates a new instance of AuthorizationDataEntry. + * + * @param adType + * @param adData */ - public AuthorizationDataEntry(AuthorizationType adType, byte[] adData) + public AuthorizationDataEntry( AuthorizationType adType, byte[] adData ) { authorizationDataType = adType; authorizationData = adData; } + /** + * Returns the raw bytes of the authorization data. + * + * @return The raw bytes of the authorization data. + */ public byte[] getAuthorizationData() { return authorizationData; } + /** + * Returns the {@link AuthorizationType}. + * + * @return The {@link AuthorizationType}. + */ public AuthorizationType getAuthorizationDataType() { return authorizationDataType; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationType.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationType.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationType.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/AuthorizationType.java Mon May 21 17:00:43 2007 @@ -32,35 +32,96 @@ public final class AuthorizationType implements Comparable { /** - * Enumeration elements are constructed once upon class loading. - * Order of appearance here determines the order of compareTo. + * Constant for the "null" authorization type. */ public static final AuthorizationType NULL = new AuthorizationType( 0, "null" ); + + /** + * Constant for the "if relevant" authorization type. + */ public static final AuthorizationType IF_RELEVANT = new AuthorizationType( 1, "if relevant" ); + + /** + * Constant for the "intended for server" authorization type. + */ public static final AuthorizationType INTENDED_FOR_SERVER = new AuthorizationType( 2, "intended for server" ); + + /** + * Constant for the "intended for application class" authorization type. + */ public static final AuthorizationType INTENDED_FOR_APPLICATION_CLASS = new AuthorizationType( 3, "intended for application class" ); + + /** + * Constant for the "kdc issued" authorization type. + */ public static final AuthorizationType KDC_ISSUED = new AuthorizationType( 4, "kdc issued" ); + + /** + * Constant for the "or" authorization type. + */ public static final AuthorizationType OR = new AuthorizationType( 5, "or" ); + + /** + * Constant for the "mandatory ticket extensions" authorization type. + */ public static final AuthorizationType MANDATORY_TICKET_EXTENSIONS = new AuthorizationType( 6, "mandatory ticket extensions" ); + + /** + * Constant for the "in ticket extensions" authorization type. + */ public static final AuthorizationType IN_TICKET_EXTENSIONS = new AuthorizationType( 7, "in ticket extensions" ); + + /** + * Constant for the "OSF DCE" authorization type. + */ public static final AuthorizationType OSF_DCE = new AuthorizationType( 64, "OSF DCE" ); + + /** + * Constant for the "sesame" authorization type. + */ public static final AuthorizationType SESAME = new AuthorizationType( 65, "sesame" ); + /** + * Array for building a List of VALUES. + */ + private static final AuthorizationType[] values = + { NULL, IF_RELEVANT, INTENDED_FOR_SERVER, INTENDED_FOR_APPLICATION_CLASS, KDC_ISSUED, OR, + MANDATORY_TICKET_EXTENSIONS, IN_TICKET_EXTENSIONS, OSF_DCE, SESAME }; - public String toString() - { - return name + " (" + ordinal + ")"; - } + /** + * A List of all the authorization type constants. + */ + public static final List VALUES = Collections.unmodifiableList( Arrays.asList( values ) ); + /** + * The name of the authorization type. + */ + private final String name; - public int compareTo( Object that ) + /** + * The value/code for the authorization type. + */ + private final int ordinal; + + + /** + * Private constructor prevents construction outside of this class. + */ + private AuthorizationType( int ordinal, String name ) { - return ordinal - ( ( AuthorizationType ) that ).ordinal; + this.ordinal = ordinal; + this.name = name; } + /** + * Returns the authorization type when specified by its ordinal. + * + * @param type + * @return The authorization type. + */ public static AuthorizationType getTypeByOrdinal( int type ) { for ( int ii = 0; ii < values.length; ii++ ) @@ -73,31 +134,25 @@ } + /** + * Returns the number associated with this authorization type. + * + * @return The authorization type ordinal. + */ public int getOrdinal() { return ordinal; } - /// PRIVATE ///// - private final String name; - private final int ordinal; - - /** - * Private constructor prevents construction outside of this class. - */ - private AuthorizationType(int ordinal, String name) + public int compareTo( Object that ) { - this.ordinal = ordinal; - this.name = name; + return ordinal - ( ( AuthorizationType ) that ).ordinal; } - /** - * These two lines are all that's necessary to export a List of VALUES. - */ - private static final AuthorizationType[] values = - { NULL, IF_RELEVANT, INTENDED_FOR_SERVER, INTENDED_FOR_APPLICATION_CLASS, KDC_ISSUED, OR, - MANDATORY_TICKET_EXTENSIONS, IN_TICKET_EXTENSIONS, OSF_DCE, SESAME }; - // VALUES needs to be located here, otherwise illegal forward reference - public static final List VALUES = Collections.unmodifiableList( Arrays.asList( values ) ); + + public String toString() + { + return name + " (" + ordinal + ")"; + } } Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/Checksum.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/Checksum.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/Checksum.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/Checksum.java Mon May 21 17:00:43 2007 @@ -35,7 +35,13 @@ private byte[] checksum; - public Checksum(ChecksumType checksumType, byte[] checksum) + /** + * Creates a new instance of Checksum. + * + * @param checksumType + * @param checksum + */ + public Checksum( ChecksumType checksumType, byte[] checksum ) { this.checksumType = checksumType; this.checksum = checksum; @@ -60,12 +66,22 @@ } + /** + * Returns the checksum value. + * + * @return The checksum value. + */ public byte[] getChecksumValue() { return checksum; } + /** + * Returns the {@link ChecksumType}. + * + * @return The {@link ChecksumType}. + */ public ChecksumType getChecksumType() { return checksumType; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedData.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedData.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedData.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedData.java Mon May 21 17:00:43 2007 @@ -34,7 +34,14 @@ private byte[] cipherText; - public EncryptedData(EncryptionType type, int version, byte[] cipherText) + /** + * Creates a new instance of EncryptedData. + * + * @param type + * @param version + * @param cipherText + */ + public EncryptedData( EncryptionType type, int version, byte[] cipherText ) { encryptionType = type; keyVersion = version; @@ -42,18 +49,33 @@ } + /** + * Returns the {@link EncryptionType}. + * + * @return The {@link EncryptionType}. + */ public EncryptionType getEncryptionType() { return encryptionType; } + /** + * Returns the key version. + * + * @return The key version. + */ public int getKeyVersion() { return keyVersion; } + /** + * Returns the raw cipher text. + * + * @return The raw cipher text. + */ public byte[] getCipherText() { return cipherText; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedDataModifier.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedDataModifier.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedDataModifier.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedDataModifier.java Mon May 21 17:00:43 2007 @@ -34,24 +34,44 @@ private byte[] cipherText; + /** + * Returns the {@link EncryptedData}. + * + * @return The {@link EncryptedData}. + */ public EncryptedData getEncryptedData() { return new EncryptedData( encryptionType, keyVersion, cipherText ); } + /** + * Sets the raw cipher text bytes. + * + * @param cipherText + */ public void setCipherText( byte[] cipherText ) { this.cipherText = cipherText; } + /** + * Sets the {@link EncryptionType}. + * + * @param type + */ public void setEncryptionType( EncryptionType type ) { encryptionType = type; } + /** + * Sets the key version. + * + * @param version + */ public void setKeyVersion( int version ) { keyVersion = version; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedTimeStamp.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedTimeStamp.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedTimeStamp.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedTimeStamp.java Mon May 21 17:00:43 2007 @@ -35,19 +35,35 @@ private int microSeconds; //optional - public EncryptedTimeStamp(KerberosTime timeStamp, int microSeconds) + /** + * Creates a new instance of EncryptedTimeStamp. + * + * @param timeStamp + * @param microSeconds + */ + public EncryptedTimeStamp( KerberosTime timeStamp, int microSeconds ) { this.timeStamp = timeStamp; this.microSeconds = microSeconds; } + /** + * Returns the {@link KerberosTime}. + * + * @return The {@link KerberosTime}. + */ public KerberosTime getTimeStamp() { return timeStamp; } + /** + * Returns the microseconds. + * + * @return The microseconds. + */ public int getMicroSeconds() { return microSeconds; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedTimeStampModifier.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedTimeStampModifier.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedTimeStampModifier.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptedTimeStampModifier.java Mon May 21 17:00:43 2007 @@ -30,18 +30,33 @@ private int microSecond; //optional + /** + * Returns the {@link EncryptedTimeStamp}. + * + * @return The {@link EncryptedTimeStamp}. + */ public EncryptedTimeStamp getEncryptedTimestamp() { return new EncryptedTimeStamp( timeStamp, microSecond ); } + /** + * Sets the {@link KerberosTime}. + * + * @param timeStamp + */ public void setKerberosTime( KerberosTime timeStamp ) { this.timeStamp = timeStamp; } + /** + * Sets the microseconds. + * + * @param microSecond + */ public void setMicroSecond( int microSecond ) { this.microSecond = microSecond; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptionKey.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptionKey.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptionKey.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptionKey.java Mon May 21 17:00:43 2007 @@ -26,6 +26,9 @@ /** + * A Kerberos symmetric encryption key, which includes metadata support for + * the associated key type and key version number. + * * @author Apache Directory Project * @version $Rev$, $Date$ */ @@ -36,46 +39,41 @@ private int keyVersion; - public EncryptionKey(EncryptionType keyType, byte[] keyValue) + /** + * Creates a new instance of EncryptionKey. + * + * @param keyType + * @param keyValue + */ + public EncryptionKey( EncryptionType keyType, byte[] keyValue ) { this.keyType = keyType; this.keyValue = keyValue; } - public EncryptionKey(EncryptionType keyType, byte[] keyValue, int keyVersion) + /** + * Creates a new instance of EncryptionKey. This constructor supports 'keyVersion', + * which is sent over the wire as part of EncryptedData but makes more sense + * in the domain model to have here as part of the key itself. Therefore, the + * keyVersion should only be constructor-injected when EncryptionKey's are + * retrieved from persisted storage. + * + * @param keyType + * @param keyValue + * @param keyVersion + */ + public EncryptionKey( EncryptionType keyType, byte[] keyValue, int keyVersion ) { this.keyType = keyType; this.keyValue = keyValue; - /** - * keyVersion is sent over the wire as part of EncryptedData but makes more sense - * in the domain model to have here as part of the key itself. Therefore, the - * keyVersion should only be constructor-injected when EncryptionKey's are - * retrieved from persisted storage. - * - * TODO - keyVersion may move into persisted user configuration - */ this.keyVersion = keyVersion; } - public boolean equals( Object o ) - { - if ( this == o ) - { - return true; - } - - if ( !( o instanceof EncryptionKey ) ) - { - return false; - } - - EncryptionKey that = ( EncryptionKey ) o; - return ( this.keyType == that.keyType ) && ( Arrays.equals( this.keyValue, that.keyValue ) ); - } - - + /** + * Destroys this key by overwriting the symmetric key material with zeros. + */ public synchronized void destroy() { if ( keyValue != null ) @@ -88,26 +86,58 @@ } - public String toString() - { - return keyType.toString() + " (" + keyType.getOrdinal() + ")"; - } - - + /** + * Returns the key type. + * + * @return The key type. + */ public EncryptionType getKeyType() { return keyType; } + /** + * Returns the key value. + * + * @return The key value. + */ public byte[] getKeyValue() { return keyValue; } + /** + * Returns the key version. + * + * @return The key version. + */ public int getKeyVersion() { return keyVersion; + } + + + public boolean equals( Object o ) + { + if ( this == o ) + { + return true; + } + + if ( !( o instanceof EncryptionKey ) ) + { + return false; + } + + EncryptionKey that = ( EncryptionKey ) o; + return ( this.keyType == that.keyType ) && ( Arrays.equals( this.keyValue, that.keyValue ) ); + } + + + public String toString() + { + return keyType.toString() + " (" + keyType.getOrdinal() + ")"; } } Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptionTypeInfoEntry.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptionTypeInfoEntry.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptionTypeInfoEntry.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/EncryptionTypeInfoEntry.java Mon May 21 17:00:43 2007 @@ -33,19 +33,35 @@ private byte[] salt; - public EncryptionTypeInfoEntry(EncryptionType encryptionType, byte[] salt) + /** + * Creates a new instance of EncryptionTypeInfoEntry. + * + * @param encryptionType + * @param salt + */ + public EncryptionTypeInfoEntry( EncryptionType encryptionType, byte[] salt ) { this.encryptionType = encryptionType; this.salt = salt; } + /** + * Returns the salt. + * + * @return The salt. + */ public byte[] getSalt() { return salt; } + /** + * Returns the {@link EncryptionType}. + * + * @return The {@link EncryptionType}. + */ public EncryptionType getEncryptionType() { return encryptionType; Modified: directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java?view=diff&rev=540371&r1=540370&r2=540371 ============================================================================== --- directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java (original) +++ directory/apacheds/trunk/kerberos-shared/src/main/java/org/apache/directory/server/kerberos/shared/messages/value/HostAddress.java Mon May 21 17:00:43 2007 @@ -37,16 +37,24 @@ /** - * Class constructors + * Creates a new instance of HostAddress. + * + * @param addressType + * @param address */ - public HostAddress(HostAddressType addressType, byte[] address) + public HostAddress( HostAddressType addressType, byte[] address ) { this.addressType = addressType; this.address = address; } - public HostAddress(InetAddress internetAddress) + /** + * Creates a new instance of HostAddress. + * + * @param internetAddress + */ + public HostAddress( InetAddress internetAddress ) { addressType = HostAddressType.ADDRTYPE_INET; byte[] newAddress = internetAddress.getAddress(); @@ -55,6 +63,12 @@ } + /** + * Returns whether one {@link HostAddress} is equal to another. + * + * @param that + * @return true if the {@link HostAddress}'s are equal. + */ public boolean equals( HostAddress that ) { if ( this.addressType != that.addressType || ( this.address != null && that.address == null ) @@ -83,12 +97,22 @@ } + /** + * Get the bytes for this address. + * + * @return The bytes of this address. + */ public byte[] getAddress() { return address; } + /** + * Returns the {@link HostAddressType} of this {@link HostAddress}. + * + * @return The {@link HostAddressType}. + */ public HostAddressType getAddressType() { return addressType;