PasswordResolver.java

// 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.doris.mysql.authenticate.password;

import org.apache.doris.mysql.MysqlAuthPacket;
import org.apache.doris.mysql.MysqlChannel;
import org.apache.doris.mysql.MysqlHandshakePacket;
import org.apache.doris.mysql.MysqlSerializer;
import org.apache.doris.mysql.authenticate.AuthenticateRequest;
import org.apache.doris.qe.ConnectContext;

import java.io.IOException;
import java.util.Optional;

public interface PasswordResolver {
    // TODO(authentication): rename this interface to CredentialResolver after legacy
    // password-only authenticators are migrated.
    Optional<Password> resolvePassword(ConnectContext context, MysqlChannel channel,
            MysqlSerializer serializer,
            MysqlAuthPacket authPacket,
            MysqlHandshakePacket handshakePacket) throws IOException;

    default Optional<AuthenticateRequest> resolveAuthenticateRequest(String userName, ConnectContext context,
            MysqlChannel channel, MysqlSerializer serializer, MysqlAuthPacket authPacket,
            MysqlHandshakePacket handshakePacket) throws IOException {
        return resolvePassword(context, channel, serializer, authPacket, handshakePacket)
                .map(password -> AuthenticateRequest.builder()
                        .userName(userName)
                        .password(password)
                        .remoteHost(channel.getRemoteIp())
                        .clientType("mysql")
                        .build());
    }
}