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/24 18:51:33 UTC
svn commit: r1038725 -
/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/EncKdcRepPart.java
Author: elecharny
Date: Wed Nov 24 17:51:32 2010
New Revision: 1038725
URL: http://svn.apache.org/viewvc?rev=1038725&view=rev
Log:
First drop for the EncKdcRepPart grammar
Added:
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/EncKdcRepPart.java
Added: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/EncKdcRepPart.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/EncKdcRepPart.java?rev=1038725&view=auto
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/EncKdcRepPart.java (added)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/components/EncKdcRepPart.java Wed Nov 24 17:51:32 2010
@@ -0,0 +1,578 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+package org.apache.directory.shared.kerberos.components;
+
+
+import java.nio.BufferOverflowException;
+import java.nio.ByteBuffer;
+
+import org.apache.directory.server.i18n.I18n;
+import org.apache.directory.shared.asn1.AbstractAsn1Object;
+import org.apache.directory.shared.asn1.ber.tlv.TLV;
+import org.apache.directory.shared.asn1.ber.tlv.Value;
+import org.apache.directory.shared.asn1.codec.EncoderException;
+import org.apache.directory.shared.kerberos.KerberosTime;
+import org.apache.directory.shared.kerberos.flags.TicketFlags;
+import org.apache.directory.shared.ldap.util.StringTools;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+/**
+ * Base class for encrypted parts of KDC responses.
+ *
+ * The ASN.1 grammar for this structure is :
+ * <pre>
+ * EncKDCRepPart ::= SEQUENCE {
+ * key [0] EncryptionKey,
+ * last-req [1] LastReq,
+ * nonce [2] UInt32,
+ * key-expiration [3] KerberosTime OPTIONAL,
+ * flags [4] TicketFlags,
+ * authtime [5] KerberosTime,
+ * starttime [6] KerberosTime OPTIONAL,
+ * endtime [7] KerberosTime,
+ * renew-till [8] KerberosTime OPTIONAL,
+ * srealm [9] Realm,
+ * sname [10] PrincipalName,
+ * caddr [11] HostAddresses OPTIONAL
+ * }
+ * </pre>
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ */
+public class EncKdcRepPart extends AbstractAsn1Object
+{
+ /** The logger */
+ private static final Logger log = LoggerFactory.getLogger( EncKdcRepPart.class );
+
+ /** Speedup for logs */
+ private static final boolean IS_DEBUG = log.isDebugEnabled();
+
+ /** The encryption key */
+ private EncryptionKey key;
+
+ /** The time of the last request */
+ private LastReq lastReq;
+
+ /** The nonce */
+ private int nonce;
+
+ /** The KeyExpiration */
+ private KerberosTime keyExpiration; //optional
+
+ /** The Ticket flags */
+ private TicketFlags flags = new TicketFlags();
+
+ /** The initial Authentication time */
+ private KerberosTime authTime;
+
+ /** The ticket's start time */
+ private KerberosTime startTime; //optional
+
+ /** The Ticket expiration time */
+ private KerberosTime endTime;
+
+ /** Maximum endtime in a renewal */
+ private KerberosTime renewTill; //optional
+
+ /** The server's realm */
+ private String srealm;
+
+ /** The server's principal */
+ private PrincipalName sname;
+
+ /** The client addresses */
+ private HostAddresses caddr; //optional
+
+ // Storage for computed lengths
+ private transient int keyLen;
+ private transient int lastReqLen;
+ private transient int nonceLen;
+ private transient int flagsLen;
+ private transient byte[] srealmBytes;
+ private transient int snameLength;
+ private transient int caddrLength;
+ private transient int encKdcRepPartSeqLen;
+
+ /**
+ * Creates a new instance of EncKdcRepPart.
+ */
+ public EncKdcRepPart()
+ {
+ }
+
+
+ /**
+ * Returns the auth {@link KerberosTime}.
+ *
+ * @return The auth {@link KerberosTime}.
+ */
+ public KerberosTime getAuthTime()
+ {
+ return authTime;
+ }
+
+
+ /**
+ * Sets the auth {@link KerberosTime}.
+ *
+ * @param time
+ */
+ public void setAuthTime( KerberosTime time )
+ {
+ authTime = time;
+ }
+
+
+ /**
+ * Returns the client {@link HostAddresses}.
+ *
+ * @return The client {@link HostAddresses}.
+ */
+ public HostAddresses getClientAddresses()
+ {
+ return caddr;
+ }
+
+
+ /**
+ * Sets the client {@link HostAddresses}.
+ *
+ * @param addresses
+ */
+ public void setClientAddresses( HostAddresses caddr )
+ {
+ this.caddr = caddr;
+ }
+
+
+ /**
+ * Returns the end {@link KerberosTime}.
+ *
+ * @return The end {@link KerberosTime}.
+ */
+ public KerberosTime getEndTime()
+ {
+ return endTime;
+ }
+
+
+ /**
+ * Sets the end {@link KerberosTime}.
+ *
+ * @param time
+ */
+ public void setEndTime( KerberosTime time )
+ {
+ endTime = time;
+ }
+
+
+ /**
+ * Returns the {@link TicketFlags}.
+ *
+ * @return The {@link TicketFlags}.
+ */
+ public TicketFlags getFlags()
+ {
+ return flags;
+ }
+
+
+ /**
+ * Sets the {@link TicketFlags}.
+ *
+ * @param flags
+ */
+ public void setFlags( TicketFlags flags )
+ {
+ this.flags = flags;
+ }
+
+
+ /**
+ * Returns the {@link EncryptionKey}.
+ *
+ * @return The {@link EncryptionKey}.
+ */
+ public EncryptionKey getKey()
+ {
+ return key;
+ }
+
+
+ /**
+ * Sets the {@link EncryptionKey}.
+ *
+ * @param key
+ */
+ public void setKey( EncryptionKey key )
+ {
+ this.key = key;
+ }
+
+
+ /**
+ * Returns the key expiration {@link KerberosTime}.
+ *
+ * @return The key expiration {@link KerberosTime}.
+ */
+ public KerberosTime getKeyExpiration()
+ {
+ return keyExpiration;
+ }
+
+
+ /**
+ * Sets the key expiration {@link KerberosTime}.
+ *
+ * @param expiration
+ */
+ public void setKeyExpiration( KerberosTime expiration )
+ {
+ keyExpiration = expiration;
+ }
+
+
+ /**
+ * Returns the {@link LastReq}.
+ *
+ * @return The {@link LastReq}.
+ */
+ public LastReq getLastReq()
+ {
+ return lastReq;
+ }
+
+
+ /**
+ * Sets the {@link LastReq}.
+ *
+ * @param lastReq The LastReq to set
+ */
+ public void setLastReq( LastReq lastReq )
+ {
+ this.lastReq = lastReq;
+ }
+
+
+ /**
+ * Returns the nonce.
+ *
+ * @return The nonce.
+ */
+ public int getNonce()
+ {
+ return nonce;
+ }
+
+
+ /**
+ * Sets the nonce.
+ *
+ * @param nonce
+ */
+ public void setNonce( int nonce )
+ {
+ this.nonce = nonce;
+ }
+
+
+ /**
+ * Returns the renew till {@link KerberosTime}.
+ *
+ * @return The renew till {@link KerberosTime}.
+ */
+ public KerberosTime getRenewTill()
+ {
+ return renewTill;
+ }
+
+
+ /**
+ * Sets the renew till {@link KerberosTime}.
+ *
+ * @param till
+ */
+ public void setRenewTill( KerberosTime till )
+ {
+ renewTill = till;
+ }
+
+
+ /**
+ * Returns the server {@link PrincipalName}.
+ *
+ * @return The server {@link PrincipalName}.
+ */
+ public PrincipalName getSName()
+ {
+ return sname;
+ }
+
+
+ /**
+ * Sets the server {@link PrincipalName}.
+ *
+ * @param principal The server PrincipalName
+ */
+ public void setSName( PrincipalName sname )
+ {
+ this.sname = sname;
+ }
+
+
+ /**
+ * Returns the server realm.
+ *
+ * @return The server realm.
+ */
+ public String getSRealm()
+ {
+ return srealm;
+ }
+
+
+ /**
+ * Sets the server realm.
+ *
+ * @param srealm The server realm
+ */
+ public void setSRealm( String srealm )
+ {
+ this.srealm = srealm;
+ }
+
+
+ /**
+ * Returns the start {@link KerberosTime}.
+ *
+ * @return The start {@link KerberosTime}.
+ */
+ public KerberosTime getStartTime()
+ {
+ return startTime;
+ }
+
+
+ /**
+ * Sets the start {@link KerberosTime}.
+ *
+ * @param time he start time to set
+ */
+ public void setStartTime( KerberosTime time )
+ {
+ startTime = time;
+ }
+
+
+ /**
+ * Compute the EncKdcRepPart length
+ * <pre>
+ * EncKdcRepPart :
+ *
+ * 0x30 L1 EncKdcRepPart sequence
+ * |
+ * +--> 0xA0 L2 key tag
+ * | |
+ * | +--> 0x30 L2-1 key ( EncryptionKey)
+ * |
+ * +--> 0xA1 L3 last-req tag
+ * | |
+ * | +--> 0x30 L3-1 last-req ( LastReq )
+ * |
+ * +--> 0xA2 L4 nonce tag
+ * | |
+ * | +--> 0x02 L4-1 nonce (Int)
+ * |
+ * [+--> 0xA3 0x11 key-expiration tag]
+ * | |
+ * | +--> 0x18 0x0F key-expiration ( KerberosTime )
+ * |
+ * +--> 0xA4 0x07 flags tag
+ * | |
+ * | +--> 0x03 0x05 flags ( TicketFlags )
+ * |
+ * +--> 0xA5 0x11 authtime tag
+ * | |
+ * | +--> 0x18 0x0F authtime ( KerberosTime )
+ * |
+ * [+--> 0xA6 0x11 starttime tag]
+ * | |
+ * | +--> 0x18 0x0F starttime ( KerberosTime )
+ * |
+ * +--> 0xA7 0x11 endtime tag
+ * | |
+ * | +--> 0x18 0x0F endtime ( KerberosTime )
+ * |
+ * [+--> 0xA8 0x11 renew-till tag]
+ * | |
+ * | +--> 0x18 0x0F renew-till ( KerberosTime )
+ * |
+ * +--> 0xA9 L5 srealm tag
+ * | |
+ * | +--> 0x1B L5-1 srealm ( KerberosString )
+ * |
+ * +--> 0xAA L6 sname tag
+ * | |
+ * | +--> 0x30 L6-1 sname ( PrincipalName )
+ * |
+ * [+--> 0xAB L7 caddr tag]
+ * |
+ * +--> 0x30 L7-1 caddr ( HostAddresses )
+ * </pre>
+ */
+ public int computeLength()
+ {
+ // The key
+ keyLen = key.computeLength();
+ encKdcRepPartSeqLen = 1 + TLV.getNbBytes( keyLen ) + keyLen;
+
+ // The last-req
+ lastReqLen = lastReq.computeLength();
+ encKdcRepPartSeqLen += 1 + TLV.getNbBytes( lastReqLen ) + lastReqLen;
+
+ // The nonce
+ nonceLen = Value.getNbBytes( nonce );
+ nonceLen = 1 + TLV.getNbBytes( nonceLen ) + nonceLen;
+ encKdcRepPartSeqLen += 1 + TLV.getNbBytes( nonceLen ) + nonceLen;
+
+ // The keyExpiration
+ if ( keyExpiration != null )
+ {
+ encKdcRepPartSeqLen += 1 + 1 + 0x11;
+ }
+
+ // The flags
+ flagsLen = 1 + 1 + 5;
+ encKdcRepPartSeqLen += 1 + TLV.getNbBytes( flagsLen ) + flagsLen;
+
+ // The authtime
+ encKdcRepPartSeqLen += 1 + 1 + 0x11;
+
+ // The starttime, if any
+ if ( startTime != null )
+ {
+ encKdcRepPartSeqLen += 1 + 1 + 0x11;
+ }
+
+ // The endtime
+ encKdcRepPartSeqLen += 1 + 1 + 0x11;
+
+ // The renew-till, if any
+ if ( renewTill != null )
+ {
+ encKdcRepPartSeqLen += 1 + 1 + 0x11;
+ }
+
+ // The srealm
+ srealmBytes = srealm.getBytes();
+ encKdcRepPartSeqLen += 1 + TLV.getNbBytes( srealmBytes.length ) + srealmBytes.length;
+
+ // The sname
+ snameLength = sname.computeLength();
+ encKdcRepPartSeqLen += 1 + TLV.getNbBytes( snameLength ) + snameLength;
+
+ // The caddr
+ caddrLength = caddr.computeLength();
+ encKdcRepPartSeqLen += 1 + TLV.getNbBytes( caddrLength ) + caddrLength;
+
+ return 1 + TLV.getNbBytes( encKdcRepPartSeqLen ) + encKdcRepPartSeqLen;
+ }
+
+
+ /**
+ * Encode the EncKdcRepPart message to a PDU.
+ *
+ * @param buffer The buffer where to put the PDU. It should have been allocated
+ * before, with the right size.
+ * @return The constructed PDU.
+ */
+ public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
+ {
+ if ( buffer == null )
+ {
+ throw new EncoderException( I18n.err( I18n.ERR_148 ) );
+ }
+
+ try
+ {
+ }
+ catch ( BufferOverflowException boe )
+ {
+ log.error( I18n.err( I18n.ERR_140, 1 + TLV.getNbBytes( 0 ) + 0,
+ buffer.capacity() ) );
+ throw new EncoderException( I18n.err( I18n.ERR_138 ) );
+ }
+
+ if ( IS_DEBUG )
+ {
+ log.debug( "EncKdcRepPart encoding : {}", StringTools.dumpBytes( buffer.array() ) );
+ log.debug( "EncKdcRepPart initial value : {}", toString() );
+ }
+
+ return buffer;
+ }
+
+
+ /**
+ * @see Object#toString()
+ */
+ public String toString()
+ {
+ StringBuilder sb = new StringBuilder();
+
+ sb.append( "EncKdcRepPart : \n" );
+ sb.append( " key : " ).append( key ).append( "\n" );
+ sb.append( " last-req : " ).append( lastReq ).append( "\n" );
+ sb.append( " nonce : " ).append( nonce ).append( "\n" );
+
+ if ( keyExpiration != null )
+ {
+ sb.append( " key-expiration : " ).append( keyExpiration ).append( "\n" );
+ }
+
+ sb.append( " flags : " ).append( flags ).append( "\n" );
+ sb.append( " authtime : " ).append( authTime ).append( "\n" );
+
+ if ( startTime != null )
+ {
+ sb.append( " starttime : " ).append( startTime ).append( "\n" );
+ }
+
+ sb.append( " endtime : " ).append( endTime ).append( "\n" );
+
+ if ( renewTill != null )
+ {
+ sb.append( " renew-till : " ).append( renewTill ).append( "\n" );
+ }
+
+ sb.append( " srealm : " ).append( srealm ).append( "\n" );
+ sb.append( " sname : " ).append( sname ).append( "\n" );
+
+ if ( caddr != null )
+ {
+ sb.append( " caddr : " ).append( caddr ).append( "\n" );
+ }
+
+ return sb.toString();
+ }
+}