Class BaseX509KeyManager

java.lang.Object

org.postgresql.ssl.BaseX509KeyManager

All Implemented Interfaces:

KeyManager, X509KeyManager

Direct Known Subclasses:

PEMKeyManager, PKCS12KeyManager

public abstract class BaseX509KeyManager
extends Object
implements X509KeyManager

Field Summary

Fields

Modifier and Type	Field	Description
protected PSQLException	error
private static final int	ROOT_UID

Constructor Summary

Constructors

Constructor	Description
BaseX509KeyManager()

Method Summary

Modifier and Type	Method	Description
String	chooseClientAlias(String[] keyType, Principal[] principals, Socket socket)
String	chooseServerAlias(String s, Principal[] principals, Socket socket)
String[]	getClientAliases(String keyType, Principal[] principals)
String[]	getServerAliases(String s, Principal[] principals)
private static boolean	hasInsecurePosixPermissions(Set<PosixFilePermission> permissions, boolean isOwnedByRoot)	Determines whether the given POSIX permissions are insecure for a private key file.
private static boolean	isFileOwnedByRoot(Path keyPath)	Checks whether the file is owned by root (uid 0).
void	throwKeyManagerException()	getCertificateChain and getPrivateKey cannot throw exceptions, therefore any exception is stored in error and can be raised by this method.
static void	validateKeyFilePermissions(Path keyPath)	Validates that the private key file has secure permissions, matching libpq behavior.
private static boolean	validatePosixPermissions(Path keyPath)	Validates POSIX file permissions of key, matching libpq behavior.
private static boolean	validateWindowsAclPermissions(Path keyPath)	Validates Windows ACL permissions of the key file.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface X509KeyManager

getCertificateChain, getPrivateKey

Field Details

ROOT_UID

private static final int ROOT_UID

See Also:

• Constant Field Values

error

protected PSQLException error

Constructor Details

BaseX509KeyManager

public BaseX509KeyManager()

Method Details

throwKeyManagerException

public void throwKeyManagerException()
                              throws PSQLException

getCertificateChain and getPrivateKey cannot throw exceptions, therefore any exception is stored in error and can be raised by this method.

Throws:

PSQLException - if any exception is stored in error and can be raised

getClientAliases

public String[] getClientAliases(String keyType,
 Principal[] principals)

Specified by:

getClientAliases in interface X509KeyManager

chooseClientAlias

public String chooseClientAlias(String[] keyType,
 Principal[] principals,
 Socket socket)

Specified by:

chooseClientAlias in interface X509KeyManager

getServerAliases

public String[] getServerAliases(String s,
 Principal[] principals)

Specified by:

getServerAliases in interface X509KeyManager

chooseServerAlias

public String chooseServerAlias(String s,
 Principal[] principals,
 Socket socket)

Specified by:

chooseServerAlias in interface X509KeyManager

validateKeyFilePermissions

public static void validateKeyFilePermissions(Path keyPath)
                                       throws PSQLException

Validates that the private key file has secure permissions, matching libpq behavior. On POSIX systems, root-owned files are allowed group-read access (up to 0640), since it's common for root to own certs and grant read access via group membership. Files owned by anyone else must be 0600 or stricter. On Windows, ACLs are checked to ensure only the owner and trusted system accounts have access.

Parameters:

keyPath - the path to the private key file

Throws:

PSQLException - if the file has insecure permissions

validatePosixPermissions

private static boolean validatePosixPermissions(Path keyPath)
                                         throws PSQLException

Validates POSIX file permissions of key, matching libpq behavior. Root-owned files (uid 0) allow GROUP_READ (up to 0640). Non-root-owned files require 0600 or less (no group or other permissions).

Parameters:

keyPath - the path to the private key file

Returns:

true if validation succeeded (permissions are secure), false if POSIX is not supported

Throws:

PSQLException - if the file has insecure permissions

isFileOwnedByRoot

private static boolean isFileOwnedByRoot(Path keyPath)
                                  throws IOException

Checks whether the file is owned by root (uid 0). Falls back to false if the unix:uid attribute is not available.

Throws:

IOException

hasInsecurePosixPermissions

private static boolean hasInsecurePosixPermissions(Set<PosixFilePermission> permissions,
 boolean isOwnedByRoot)

Determines whether the given POSIX permissions are insecure for a private key file. Matches libpq behavior: root-owned files allow GROUP_READ (0640), while non-root-owned files reject all group and other permissions (0600).

validateWindowsAclPermissions

private static boolean validateWindowsAclPermissions(Path keyPath)
                                              throws PSQLException

Validates Windows ACL permissions of the key file.

Parameters:

keyPath - the path to the private key file

Returns:

true if validation succeeded (permissions are secure), false if ACL is not supported

Throws:

PSQLException - if the file has insecure permissions