Package org.pkl.core

Interface SecurityManager

public interface SecurityManager

Enforces a security model during evaluation.

Use SecurityManagers to obtain or construct an instance of this type.

Method Summary

Modifier and Type	Method	Description
void	checkImportModule(URI importingModule, URI importedModule)	Checks if the given importing module may import the given imported module.
void	checkReadResource(URI resource)	Checks if the given resource may be read.
void	checkResolveModule(URI uri)	Checks if the given module may be resolved.
void	checkResolveResource(URI resource)	Checks if the given resource may be resolved.
default @Nullable Path	resolveSecurePath(URI uri)	Resolves the given file: URI to a secure, symlink-free path that has been verified to be within the root directory (if one is configured).

Method Details

checkResolveModule

void checkResolveModule(URI uri)
                 throws SecurityManagerException

Checks if the given module may be resolved. This check is required before any attempt is made to access the given URI.

Throws:

SecurityManagerException

checkImportModule

void checkImportModule(URI importingModule,
 URI importedModule)
                throws SecurityManagerException

Checks if the given importing module may import the given imported module.

Throws:

SecurityManagerException

checkReadResource

void checkReadResource(URI resource)
                throws SecurityManagerException

Checks if the given resource may be read.

Throws:

SecurityManagerException

checkResolveResource

void checkResolveResource(URI resource)
                   throws SecurityManagerException

Checks if the given resource may be resolved. This check is required before any attempt is made to access the given URI.

Throws:

SecurityManagerException

resolveSecurePath

@Nullable
default @Nullable Path resolveSecurePath(URI uri)
                                  throws SecurityManagerException,
IOException

Resolves the given file: URI to a secure, symlink-free path that has been verified to be within the root directory (if one is configured). The returned path can be opened with LinkOption.NOFOLLOW_LINKS.

Returns null for non-file: URIs or if no root directory is configured.

Parameters:

uri - the URI to resolve

Returns:

the resolved, symlink-free path under root directory, or null

Throws:

SecurityManagerException - if the resolved path is not within the root directory

IOException - if the path cannot be resolved