com.novell.ldapchai.cr.Answer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldapchai Show documentation
The LDAP Chai API, easy to use LDAP for Java developers.
The newest version!
/*
 * LDAP Chai API
 * Copyright (c) 2006-2017 Novell, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package com.novell.ldapchai.cr;

import com.novell.ldapchai.cr.bean.AnswerBean;
import com.novell.ldapchai.exception.ChaiOperationException;
import com.novell.ldapchai.util.internal.StringHelper;
import org.jrivard.xmlchai.XmlElement;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;

/**
 * An {@code Answer} is an instance of a response to a challenge/response question.
 */
public interface Answer
{
    boolean testAnswer( String answer );

    XmlElement toXml()
            throws ChaiOperationException;

    AnswerBean asAnswerBean();

    /**
     * Defined format types for answers.  Format types typically denote the hash mechanism (if any)
     * and any other character encoding and possibly the storage system.
     */
    enum FormatType
    {
        TEXT( new TextAnswer.TextAnswerFactory(), 0, 0 ),
        MD5( new HashSaltAnswer.HashSaltAnswerFactory(), 0, 2_000_000, Flag.HashThreadingEligible ),
        SHA1( new HashSaltAnswer.HashSaltAnswerFactory(), 0, 2_000_000, Flag.HashThreadingEligible ),
        SHA1_SALT( new HashSaltAnswer.HashSaltAnswerFactory(), 32, 2_000_000, Flag.HashThreadingEligible ),
        SHA256_SALT( new HashSaltAnswer.HashSaltAnswerFactory(), 32, 2_000_000, Flag.HashThreadingEligible ),
        SHA512_SALT( new HashSaltAnswer.HashSaltAnswerFactory(), 32, 2_000_000, Flag.HashThreadingEligible ),
        BCRYPT( new PasswordCryptAnswer.PasswordCryptAnswerFactory(), 16, 15, Flag.HashThreadingEligible ),
        SCRYPT( new PasswordCryptAnswer.PasswordCryptAnswerFactory(), 32, 16 * 1024, Flag.HashThreadingEligible ),
        PBKDF2( new PBKDF2Answer.PKDBF2AnswerFactory(), 32, 500_000, Flag.HashThreadingEligible ),
        PBKDF2_SHA256( new PBKDF2Answer.PKDBF2AnswerFactory(), 32, 500_000, Flag.HashThreadingEligible ),
        PBKDF2_SHA512( new PBKDF2Answer.PKDBF2AnswerFactory(), 32, 500_000, Flag.HashThreadingEligible ),
        HELPDESK( new ChaiHelpdeskAnswer.ChaiHelpdeskAnswerFactory(), 0, 0 ),
        NMAS( null, -1, -1 ),;

        private final transient ImplementationFactory factory;
        private final int saltLength;
        private final int defaultIterations;
        private final boolean hashThreadingEligible;

        FormatType(
                final ImplementationFactory implementationClass,
                final int saltLength,
                final int defaultIterations,
                final Flag... flags
        )
        {
            this.factory = implementationClass;
            this.saltLength = saltLength;
            this.defaultIterations = defaultIterations;
            this.hashThreadingEligible = StringHelper.enumArrayContainsValue( flags, Flag.HashThreadingEligible );
        }

        private enum Flag
        {
            HashThreadingEligible,
        }

        public ImplementationFactory getFactory()
        {
            return factory;
        }

        public int getDefaultIterations()
        {
            return defaultIterations;
        }

        public int getSaltLength()
        {
            return saltLength;
        }

        public boolean isHashThreadingEligible()
        {
            return hashThreadingEligible;
        }

        public static List implementedValues()
        {
            return Arrays.stream( values() )
                    .filter( formatType -> formatType.getFactory() != null )
                    .collect( Collectors.collectingAndThen( Collectors.toList(), Collections::unmodifiableList ) );
        }
    }

    /**
     * Interface for any factory class that can instantiate an {@link Answer}.
     */
    interface ImplementationFactory
    {
        Answer newAnswer( AnswerConfiguration answerConfiguration, String answerText );

        Answer fromAnswerBean( AnswerBean input, String challengeText );

        Answer fromXml( XmlElement element, boolean caseInsensitive, String challengeText );
    }


}