PgpassFileReader.java

/*-
 * ========================LICENSE_START=================================
 * flyway-core
 * ========================================================================
 * Copyright (C) 2010 - 2025 Red Gate Software Ltd
 * ========================================================================
 * Licensed 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.
 * =========================LICENSE_END==================================
 */
package org.flywaydb.core.internal.authentication.postgres;

import lombok.CustomLog;
import org.flywaydb.core.internal.authentication.ExternalAuthFileReader;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

@CustomLog
public class PgpassFileReader implements ExternalAuthFileReader {

    @Override
    public List<String> getAllContents() {
        List<String> fileContents = new ArrayList<>();

        String pgpassFilePath = getPgpassFilePath();
        if (pgpassFilePath == null) {
            return fileContents;
        }

        LOG.debug("Found pgpass file '" + pgpassFilePath + "'.");
        try {
            fileContents.add(new String(Files.readAllBytes(Paths.get(pgpassFilePath))));
        } catch (IOException e) {
            LOG.debug("Unable to read from pgpass file '" + pgpassFilePath + "'.");
        }

        return fileContents;
    }

    public String getPgpassFilePath() {
        // Priority for the pgpass file goes to the environment variable
        String pgpassEnvPath = System.getenv("PGPASSFILE");
        if (pgpassEnvPath != null) {
            return pgpassEnvPath;
        }

        File pgpassFile;
        boolean isWindows = System.getProperty("os.name").toLowerCase(Locale.ENGLISH).contains("win");
        // The pgpass file is under 'APPDATA' in windows and the user's home directory otherwise
        if (isWindows) {
            pgpassFile = new File(System.getenv("APPDATA"), "postgresql\\pgpass.conf");
        } else {
            pgpassFile = new File(System.getProperty("user.home"), ".pgpass");
        }
        if (pgpassFile.exists()) {
            return pgpassFile.getAbsolutePath();
        }
        return null;
    }
}