001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027package org.apache.http.impl.auth;
028
029/**
030 * Abstract NTLM authentication engine. The engine can be used to
031 * generate Type1 messages and Type3 messages in response to a
032 * Type2 challenge.
033 *
034 * @since 4.0
035 */
036public interface NTLMEngine {
037
038    /**
039     * Generates a Type1 message given the domain and workstation.
040     *
041     * @param domain Optional Windows domain name. Can be {@code null}.
042     * @param workstation Optional Windows workstation name. Can be
043     *  {@code null}.
044     * @return Type1 message
045     * @throws NTLMEngineException
046     */
047    String generateType1Msg(
048            String domain,
049            String workstation) throws NTLMEngineException;
050
051    /**
052     * Generates a Type3 message given the user credentials and the
053     * authentication challenge.
054     *
055     * @param username Windows user name
056     * @param password Password
057     * @param domain Windows domain name
058     * @param workstation Windows workstation name
059     * @param challenge Type2 challenge.
060     * @return Type3 response.
061     * @throws NTLMEngineException
062     */
063    String generateType3Msg(
064            String username,
065            String password,
066            String domain,
067            String workstation,
068            String challenge) throws NTLMEngineException;
069
070}