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.authorizationData;
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.authorizationData.actions.AuthorizationDataInit;
030import org.apache.directory.shared.kerberos.codec.authorizationData.actions.StoreAdData;
031import org.apache.directory.shared.kerberos.codec.authorizationData.actions.StoreAdType;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * This class implements the AuthorizationData 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 AuthorizationDataGrammar extends AbstractGrammar<AuthorizationDataContainer>
044{
045    /** The logger */
046    static final Logger LOG = LoggerFactory.getLogger( AuthorizationDataGrammar.class );
047
048    /** A speedup for logger */
049    static final boolean IS_DEBUG = LOG.isDebugEnabled();
050
051    /** The instance of grammar. AuthorizationDataGrammar is a singleton */
052    private static Grammar<AuthorizationDataContainer> instance = new AuthorizationDataGrammar();
053
054
055    /**
056     * Creates a new AuthorizationDataGrammar object.
057     */
058    @SuppressWarnings("unchecked")
059    private AuthorizationDataGrammar()
060    {
061        setName( AuthorizationDataGrammar.class.getName() );
062
063        // Create the transitions table
064        super.transitions = new GrammarTransition[AuthorizationDataStatesEnum.LAST_AUTHORIZATION_DATA_STATE.ordinal()][256];
065
066        // ============================================================================================
067        // AuthorizationData
068        // ============================================================================================
069        // --------------------------------------------------------------------------------------------
070        // Transition from AuthorizationData init to AuthorizationData SEQ OF
071        // --------------------------------------------------------------------------------------------
072        // AuthorizationData   ::= SEQUENCE OF
073        super.transitions[AuthorizationDataStatesEnum.START_STATE.ordinal()][UniversalTag.SEQUENCE.getValue()] =
074            new GrammarTransition<AuthorizationDataContainer>(
075                AuthorizationDataStatesEnum.START_STATE,
076                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_SEQ_SEQ_STATE,
077                UniversalTag.SEQUENCE,
078                new AuthorizationDataInit() );
079
080        // --------------------------------------------------------------------------------------------
081        // Transition from AuthorizationData SEQ OF to SEQ
082        // --------------------------------------------------------------------------------------------
083        // AuthorizationData  ::= SEQUENCE OF SEQUENCE {
084        super.transitions[AuthorizationDataStatesEnum.AUTHORIZATION_DATA_SEQ_SEQ_STATE.ordinal()][UniversalTag.SEQUENCE
085            .getValue()] =
086            new GrammarTransition<AuthorizationDataContainer>(
087                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_SEQ_SEQ_STATE,
088                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_SEQ_STATE,
089                UniversalTag.SEQUENCE,
090                new CheckNotNullLength<AuthorizationDataContainer>() );
091
092        // --------------------------------------------------------------------------------------------
093        // Transition from AuthorizationData SEQ OF to adType tag
094        // --------------------------------------------------------------------------------------------
095        // AuthorizationData  ::= SEQUENCE OF SEQUENCE {
096        //         ad-type     [0]
097        super.transitions[AuthorizationDataStatesEnum.AUTHORIZATION_DATA_SEQ_STATE.ordinal()][KerberosConstants.AUTHORIZATION_DATA_ADTYPE_TAG] =
098            new GrammarTransition<AuthorizationDataContainer>(
099                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_SEQ_STATE,
100                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADTYPE_TAG_STATE,
101                KerberosConstants.AUTHORIZATION_DATA_ADTYPE_TAG,
102                new CheckNotNullLength<AuthorizationDataContainer>() );
103
104        // --------------------------------------------------------------------------------------------
105        // Transition from adtype tag to adtype value
106        // --------------------------------------------------------------------------------------------
107        // AuthorizationData  ::= SEQUENCE OF SEQUENCE {
108        //         ad-type     [0] Int32,
109        super.transitions[AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADTYPE_TAG_STATE.ordinal()][UniversalTag.INTEGER
110            .getValue()] =
111            new GrammarTransition<AuthorizationDataContainer>(
112                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADTYPE_TAG_STATE,
113                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADTYPE_STATE,
114                UniversalTag.INTEGER,
115                new StoreAdType() );
116
117        // --------------------------------------------------------------------------------------------
118        // Transition from ad-type value to ad-data tag
119        // --------------------------------------------------------------------------------------------
120        // AuthorizationData   ::= SEQUENCE OF SEQUENCE {
121        //         ...
122        //         ad-data     [1]
123        super.transitions[AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADTYPE_STATE.ordinal()][KerberosConstants.AUTHORIZATION_DATA_ADDATA_TAG] =
124            new GrammarTransition<AuthorizationDataContainer>(
125                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADTYPE_STATE,
126                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADDATA_TAG_STATE,
127                KerberosConstants.AUTHORIZATION_DATA_ADDATA_TAG,
128                new CheckNotNullLength<AuthorizationDataContainer>() );
129
130        // --------------------------------------------------------------------------------------------
131        // Transition from ad-data tag to ad-data value
132        // --------------------------------------------------------------------------------------------
133        // AuthorizationData   ::= SEQUENCE OF SEQUENCE {
134        //         ...
135        //         ad-data     [1] (OCTET STRING)
136        super.transitions[AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADDATA_TAG_STATE.ordinal()][UniversalTag.OCTET_STRING
137            .getValue()] =
138            new GrammarTransition<AuthorizationDataContainer>(
139                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADDATA_TAG_STATE,
140                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADDATA_STATE,
141                UniversalTag.OCTET_STRING,
142                new StoreAdData() );
143
144        // --------------------------------------------------------------------------------------------
145        // Transition from ad-data value to SEQUENCE
146        // --------------------------------------------------------------------------------------------
147        // AuthorizationData   ::= SEQUENCE {
148        //         ...
149        //         ad-data     [1] (OCTET STRING)
150        super.transitions[AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADDATA_STATE.ordinal()][UniversalTag.SEQUENCE
151            .getValue()] =
152            new GrammarTransition<AuthorizationDataContainer>(
153                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_ADDATA_STATE,
154                AuthorizationDataStatesEnum.AUTHORIZATION_DATA_SEQ_STATE,
155                UniversalTag.SEQUENCE,
156                new CheckNotNullLength<AuthorizationDataContainer>() );
157    }
158
159
160    /**
161     * Get the instance of this grammar
162     *
163     * @return An instance on the AuthorizationData Grammar
164     */
165    public static Grammar<AuthorizationDataContainer> getInstance()
166    {
167        return instance;
168    }
169}