org.apache.james.protocols.smtp.hook.AuthHook Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of protocols-smtp

There is a newer version: 3.8.1

/****************************************************************
 * 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.james.protocols.smtp.hook;

import org.apache.james.core.Username;
import org.apache.james.protocols.api.OidcSASLConfiguration;
import org.apache.james.protocols.smtp.SMTPSession;

/**
 * Implement this interfaces to hook in the AUTH Command
 */
public interface AuthHook extends Hook {

    /**
     * Return the HookResult after run the hook
     * 
     * @param session the SMTPSession
     * @param username the username
     * @param password the password
     * @return HockResult
     */
    HookResult doAuth(SMTPSession session, Username username, String password);

    HookResult doSasl(SMTPSession session, OidcSASLConfiguration saslConfiguration, String initialResponse);

    default HookResult doDelegation(SMTPSession session, Username target) {
        return HookResult.DECLINED;
    }
}