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/18 14:41:19 UTC
svn commit: r1036456 -
/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/ApReq.java
Author: elecharny
Date: Thu Nov 18 13:41:18 2010
New Revision: 1036456
URL: http://svn.apache.org/viewvc?rev=1036456&view=rev
Log:
Added the AP-REQ message
Added:
directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/ApReq.java
Added: directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/ApReq.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/ApReq.java?rev=1036456&view=auto
==============================================================================
--- directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/ApReq.java (added)
+++ directory/apacheds/trunk/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/messages/ApReq.java Thu Nov 18 13:41:18 2010
@@ -0,0 +1,335 @@
+/*
+ * 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.messages;
+
+import java.nio.BufferOverflowException;
+import java.nio.ByteBuffer;
+
+import org.apache.directory.server.i18n.I18n;
+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.KerberosConstants;
+import org.apache.directory.shared.kerberos.KerberosMessageType;
+import org.apache.directory.shared.kerberos.codec.options.ApOptions;
+import org.apache.directory.shared.kerberos.components.EncryptedData;
+import org.apache.directory.shared.ldap.util.StringTools;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+/**
+ * AP-REQ message component . It will store the object described by the ASN.1 grammar :
+ * <pre>
+ * AP-REQ ::= [APPLICATION 14] SEQUENCE {
+ * pvno [0] INTEGER (5),
+ * msg-type [1] INTEGER (14),
+ * ap-options [2] APOptions,
+ * ticket [3] Ticket,
+ * authenticator [4] EncryptedData -- Authenticator
+ * }
+ * </pre>
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ */
+public class ApReq extends KerberosMessage
+{
+ /** The logger */
+ private static final Logger LOG = LoggerFactory.getLogger( ApReq.class );
+
+ /** Speedup for logs */
+ private static final boolean IS_DEBUG = LOG.isDebugEnabled();
+
+ /** The AP options */
+ private ApOptions apOptions;
+
+ /** The Ticket */
+ private Ticket ticket;
+
+ /** The encryptedData, an encrypted Authenticator */
+ private EncryptedData authenticator;
+
+ // Storage for computed lengths
+ private transient int pvnoLength;
+ private transient int msgTypeLength;
+ private transient int apOptionsLength;
+ private transient int ticketLength;
+ private transient int authenticatorLength;
+ private transient int apReqLength;
+
+ /**
+ * Creates a new instance of ApplicationRequest.
+ */
+ public ApReq()
+ {
+ super( KerberosMessageType.AP_REQ );
+ }
+
+
+ /**
+ * Returns the {@link ApOptions}.
+ *
+ * @return The {@link ApOptions}.
+ */
+ public ApOptions getApOptions()
+ {
+ return apOptions;
+ }
+
+
+ /**
+ * Returns the {@link Ticket}.
+ *
+ * @return The {@link Ticket}.
+ */
+ public Ticket getTicket()
+ {
+ return ticket;
+ }
+
+
+ /**
+ * Returns the option at a specified index.
+ *
+ * @param option
+ * @return The option.
+ */
+ public boolean getOption( int option )
+ {
+ return apOptions.get( option );
+ }
+
+
+ /**
+ * Sets the option at a specified index.
+ *
+ * @param option
+ */
+ public void setOption( int option )
+ {
+ apOptions.set( option );
+ }
+
+
+ /**
+ * Clears the option at a specified index.
+ *
+ * @param option
+ */
+ public void clearOption( int option )
+ {
+ apOptions.clear( option );
+ }
+
+
+ /**
+ * Returns the {@link EncryptedData}.
+ *
+ * @return The {@link EncryptedData}.
+ */
+ public EncryptedData getAuthenticator()
+ {
+ return authenticator;
+ }
+
+
+ /**
+ * Sets the {@link EncryptedData}.
+ *
+ * @param authenticator The encrypted authenticator
+ */
+ public void setAuthenticator( EncryptedData authenticator )
+ {
+ this.authenticator = authenticator;
+ }
+
+
+ /**
+ * Sets the {@link ApOptions}.
+ *
+ * @param options
+ */
+ public void setApOptions( ApOptions options )
+ {
+ apOptions = options;
+ }
+
+
+ /**
+ * Sets the {@link Ticket}.
+ *
+ * @param ticket
+ */
+ public void setTicket( Ticket ticket )
+ {
+ this.ticket = ticket;
+ }
+
+
+ /**
+ * Compute the AP-REQ length
+ * <pre>
+ * AP-REQ :
+ *
+ * 0x6E L1 AP-REQ [APPLICATION 14]
+ * |
+ * +--> 0xA0 0x03 pvno tag
+ * | |
+ * | +--> 0x02 0x01 0x05 pvno (5)
+ * |
+ * +--> 0xA1 0x03 msg-type tag
+ * | |
+ * | +--> 0x02 0x01 0x0E msg-type (14)
+ * |
+ * +--> 0xA2 0x03 APOptions tag
+ * | |
+ * | +--> 0x03 0x05 0x00 b1 b2 b3 b4 APOtions
+ * |
+ * +--> 0xA3 L3 ticket tag
+ * | |
+ * | +--> 0x61 L3-1 ticket
+ * |
+ * +--> 0xA4 L4 authenticator tag
+ * |
+ * +--> 0x30 L4-1 authenticator (encrypted)
+ * </pre>
+ */
+ public int computeLength()
+ {
+ // Compute the PVNO length.
+ pvnoLength = 1 + 1 + Value.getNbBytes( getProtocolVersionNumber() );
+
+ // Compute the msg-type length
+ msgTypeLength = 1 + 1 + Value.getNbBytes( getMessageType().getValue() );
+
+ // Compute the APOptions length
+ apOptionsLength = 1 + 1 + apOptions.getBytes().length;
+
+ // Compute the ticket length
+ ticketLength = ticket.computeLength();
+
+ // Compute the authenticator length
+ authenticatorLength = authenticator.computeLength();
+
+ // Compute the sequence size
+ apReqLength =
+ 1 + TLV.getNbBytes( pvnoLength ) + pvnoLength +
+ 1 + TLV.getNbBytes( msgTypeLength ) + msgTypeLength +
+ 1 + TLV.getNbBytes( apOptionsLength ) + apOptionsLength +
+ 1 + TLV.getNbBytes( ticketLength ) + ticketLength +
+ 1 + TLV.getNbBytes( authenticatorLength ) + authenticatorLength;
+
+ return 1 + TLV.getNbBytes( apReqLength ) + apReqLength;
+ }
+
+
+ /**
+ * Encode the AP-REQ component
+ *
+ * @param buffer The buffer containing the encoded result
+ * @return The encoded component
+ * @throws EncoderException If the encoding failed
+ */
+ public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
+ {
+ if ( buffer == null )
+ {
+ buffer = ByteBuffer.allocate( computeLength() );
+ }
+
+ try
+ {
+ // The AP-REP Tag
+ buffer.put( (byte)KerberosConstants.AP_REQ_TAG );
+ buffer.put( TLV.getBytes( apReqLength ) );
+
+ // The PVNO -------------------------------------------------------
+ // The tag
+ buffer.put( (byte)KerberosConstants.AP_REQ_PVNO_TAG );
+ buffer.put( TLV.getBytes( pvnoLength ) );
+
+ // The value
+ Value.encode( buffer, getProtocolVersionNumber() );
+
+ // The msg-type ---------------------------------------------------
+ // The tag
+ buffer.put( (byte)KerberosConstants.AP_REQ_MSG_TYPE_TAG );
+ buffer.put( TLV.getBytes( msgTypeLength ) );
+
+ // The value
+ Value.encode( buffer, getMessageType().getValue() );
+
+ // The ap-options -------------------------------------------------
+ // The tag
+ buffer.put( (byte)KerberosConstants.AP_REQ_AP_OPTIONS_TAG );
+ buffer.put( TLV.getBytes( apOptionsLength ) );
+
+ // The value
+ Value.encode( buffer, apOptions );
+
+ // The ticket -----------------------------------------------------
+ // The tag
+ buffer.put( (byte)KerberosConstants.AP_REQ_TICKET_TAG );
+ buffer.put( TLV.getBytes( ticketLength ) );
+
+ // The value
+ ticket.encode( buffer );
+
+ // The authenticator ----------------------------------------------
+ // The tag
+ buffer.put( (byte)KerberosConstants.AP_REQ_AUTHENTICATOR_TAG );
+ buffer.put( TLV.getBytes( authenticatorLength ) );
+
+ // The value
+ authenticator.encode( buffer );
+ }
+ catch ( BufferOverflowException boe )
+ {
+ LOG.error( I18n.err( I18n.ERR_137, 1 + TLV.getNbBytes( apReqLength ) + apReqLength,
+ buffer.capacity() ) );
+ throw new EncoderException( I18n.err( I18n.ERR_138 ) );
+ }
+
+ if ( IS_DEBUG )
+ {
+ LOG.debug( "AP-REQ encoding : {}", StringTools.dumpBytes( buffer.array() ) );
+ LOG.debug( "AP-REQ initial value : {}", toString() );
+ }
+
+ return buffer;
+ }
+
+
+ /**
+ * @see Object#toString()
+ */
+ public String toString()
+ {
+ StringBuilder sb = new StringBuilder();
+
+ sb.append( "AP-REQ :\n" );
+ sb.append( " pvno : " ).append( getProtocolVersionNumber() ).append( "\n" );
+ sb.append( " msg-type : " ).append( getMessageType() ).append( "\n" );
+ sb.append( " ap-options : " ).append( apOptions ).append( "\n" );
+ sb.append( " ticket : " ).append( ticket ).append( "\n" );
+ sb.append( " authenticator : " ).append( authenticator ).append( "\n" );
+
+ return sb.toString();
+ }
+}