001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.directory.shared.kerberos.codec.encryptionKey;
021
022
023import org.apache.directory.api.asn1.actions.CheckNotNullLength;
024import org.apache.directory.api.asn1.ber.grammar.AbstractGrammar;
025import org.apache.directory.api.asn1.ber.grammar.Grammar;
026import org.apache.directory.api.asn1.ber.grammar.GrammarTransition;
027import org.apache.directory.api.asn1.ber.tlv.UniversalTag;
028import org.apache.directory.shared.kerberos.KerberosConstants;
029import org.apache.directory.shared.kerberos.codec.encryptionKey.actions.EncryptionKeyInit;
030import org.apache.directory.shared.kerberos.codec.encryptionKey.actions.StoreKeyType;
031import org.apache.directory.shared.kerberos.codec.encryptionKey.actions.StoreKeyValue;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * This class implements the EncryptionKey structure. All the actions are declared
038 * in this class. As it is a singleton, these declaration are only done once. If
039 * an action is to be added or modified, this is where the work is to be done !
040 *
041 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
042 */
043public final class EncryptionKeyGrammar extends AbstractGrammar<EncryptionKeyContainer>
044{
045    /** The logger */
046    static final Logger LOG = LoggerFactory.getLogger( EncryptionKeyGrammar.class );
047
048    /** A speedup for logger */
049    static final boolean IS_DEBUG = LOG.isDebugEnabled();
050
051    /** The instance of grammar. EncryptionKeyGrammar is a singleton */
052    private static Grammar<EncryptionKeyContainer> instance = new EncryptionKeyGrammar();
053
054
055    /**
056     * Creates a new EncryptionKeyGrammar object.
057     */
058    @SuppressWarnings("unchecked")
059    private EncryptionKeyGrammar()
060    {
061        setName( EncryptionKeyGrammar.class.getName() );
062
063        // Create the transitions table
064        super.transitions = new GrammarTransition[EncryptionKeyStatesEnum.LAST_ENCRYPTION_KEY_STATE.ordinal()][256];
065
066        // ============================================================================================
067        // EncryptionKey
068        // ============================================================================================
069        // --------------------------------------------------------------------------------------------
070        // Transition from EncryptionKey init to EncryptionKey SEQ OF
071        // --------------------------------------------------------------------------------------------
072        // EncryptionKey         ::= SEQUENCE {
073        super.transitions[EncryptionKeyStatesEnum.START_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
074            new GrammarTransition<EncryptionKeyContainer>(
075                EncryptionKeyStatesEnum.START_STATE,
076                EncryptionKeyStatesEnum.ENCRYPTION_KEY_SEQ_STATE,
077                UniversalTag.SEQUENCE,
078                new EncryptionKeyInit() );
079
080        // --------------------------------------------------------------------------------------------
081        // Transition from EncryptionKey SEQ to key-type tag
082        // --------------------------------------------------------------------------------------------
083        // EncryptionKey         ::= SEQUENCE {
084        //       keytype     [0]
085        super.transitions[EncryptionKeyStatesEnum.ENCRYPTION_KEY_SEQ_STATE.ordinal()][KerberosConstants.ENCRYPTION_KEY_TYPE_TAG] =
086            new GrammarTransition<EncryptionKeyContainer>(
087                EncryptionKeyStatesEnum.ENCRYPTION_KEY_SEQ_STATE,
088                EncryptionKeyStatesEnum.ENCRYPTION_KEY_TYPE_TAG_STATE,
089                KerberosConstants.ENCRYPTION_KEY_TYPE_TAG,
090                new CheckNotNullLength<EncryptionKeyContainer>() );
091
092        // --------------------------------------------------------------------------------------------
093        // Transition from EncryptionKey type tag to key-type value
094        // --------------------------------------------------------------------------------------------
095        // EncryptionKey         ::= SEQUENCE {
096        //       keytype     [0] Int32
097        super.transitions[EncryptionKeyStatesEnum.ENCRYPTION_KEY_TYPE_TAG_STATE.ordinal()][UniversalTag.INTEGER
098            .getValue()] =
099            new GrammarTransition<EncryptionKeyContainer>(
100                EncryptionKeyStatesEnum.ENCRYPTION_KEY_TYPE_TAG_STATE,
101                EncryptionKeyStatesEnum.ENCRYPTION_KEY_TYPE_STATE,
102                UniversalTag.INTEGER,
103                new StoreKeyType() );
104
105        // --------------------------------------------------------------------------------------------
106        // Transition from key-type to key-value tag
107        // --------------------------------------------------------------------------------------------
108        // EncryptionKey         ::= SEQUENCE {
109        //          ...
110        //          keyvalue    [2]
111        super.transitions[EncryptionKeyStatesEnum.ENCRYPTION_KEY_TYPE_STATE.ordinal()][KerberosConstants.ENCRYPTION_KEY_VALUE_TAG] =
112            new GrammarTransition<EncryptionKeyContainer>(
113                EncryptionKeyStatesEnum.ENCRYPTION_KEY_TYPE_STATE,
114                EncryptionKeyStatesEnum.ENCRYPTION_KEY_VALUE_TAG_STATE,
115                KerberosConstants.ENCRYPTION_KEY_VALUE_TAG,
116                new CheckNotNullLength<EncryptionKeyContainer>() );
117
118        // --------------------------------------------------------------------------------------------
119        // Transition from key-value tag to key-value value
120        // --------------------------------------------------------------------------------------------
121        // EncryptionKey         ::= SEQUENCE {
122        //          keyvalue    [2] OCTET STRING
123        super.transitions[EncryptionKeyStatesEnum.ENCRYPTION_KEY_VALUE_TAG_STATE.ordinal()][UniversalTag.OCTET_STRING
124            .getValue()] =
125            new GrammarTransition<EncryptionKeyContainer>(
126                EncryptionKeyStatesEnum.ENCRYPTION_KEY_VALUE_TAG_STATE,
127                EncryptionKeyStatesEnum.ENCRYPTION_KEY_VALUE_STATE,
128                UniversalTag.OCTET_STRING,
129                new StoreKeyValue() );
130    }
131
132
133    /**
134     * Get the instance of this grammar
135     *
136     * @return An instance on the EncryptionKey Grammar
137     */
138    public static Grammar<EncryptionKeyContainer> getInstance()
139    {
140        return instance;
141    }
142}