Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions src/main/java/land/oras/Registry.java
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ public final class Registry extends OCI<ContainerRef> {
/**
* The containers policy for trust verification
*/
private ContainersPolicy containersPolicy;
private @Nullable ContainersPolicy containersPolicy;

/**
* Constructor
Expand All @@ -171,7 +171,6 @@ private Registry() {
this.authProvider = new NoAuthProvider();
this.client = HttpClient.Builder.builder().build();
this.registriesConf = RegistriesConf.newConf();
this.containersPolicy = ContainersPolicy.newPolicy(); // Load from standard locations or accept-all
}

@Override
Expand Down Expand Up @@ -302,7 +301,7 @@ boolean isTransportLocked() {
* @return the containers policy
*/
public ContainersPolicy getContainersPolicy() {
return containersPolicy;
return Objects.requireNonNull(containersPolicy, "containersPolicy");
}

/**
Expand Down Expand Up @@ -390,6 +389,9 @@ private void setContainersPolicy(ContainersPolicy containersPolicy) {
* @return The provider
*/
private Registry build() {
if (containersPolicy == null) {
containersPolicy = ContainersPolicy.newPolicy();
}
HttpClient.Builder clientBuilder = HttpClient.Builder.builder()
.withSkipTlsVerify(skipTlsVerify)
.withMaxRetries(maxRetries)
Expand Down Expand Up @@ -1916,7 +1918,7 @@ public Builder from(Registry registry) {
this.registry.setMaxRetryDelayMs(registry.maxRetryDelayMs);
this.registry.setTagListMaxPages(registry.tagListMaxPages);
this.registry.setReferrerListMaxPages(registry.referrerListMaxPages);
this.registry.setContainersPolicy(registry.containersPolicy);
this.registry.setContainersPolicy(registry.getContainersPolicy());
if (registry.meterRegistry != null) {
this.registry.setMeterRegistry(registry.meterRegistry);
}
Expand Down Expand Up @@ -2169,7 +2171,7 @@ public Builder withReferrerListMaxPages(int referrerListMaxPages) {
* @see ContainersPolicy#newPolicy()
*/
public Builder withPolicy(ContainersPolicy policy) {
registry.setContainersPolicy(policy);
registry.setContainersPolicy(Objects.requireNonNull(policy, "policy"));
return this;
}

Expand Down
23 changes: 22 additions & 1 deletion src/main/java/land/oras/policy/ContainersPolicy.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import land.oras.OrasModel;
import land.oras.exception.OrasException;
import land.oras.utils.JsonUtils;
Expand Down Expand Up @@ -75,6 +76,26 @@ public class ContainersPolicy {
this.policyFile = policyFile;
}

/**
* Create a policy that accepts any image unconditionally.
*
* @return a policy with {@code insecureAcceptAnything} as its global default.
*/
public static ContainersPolicy acceptAnything() {
return new ContainersPolicy(PolicyFile.fromJson(List.of(new PolicyRequirement.InsecureAcceptAnything()), null));
}

/**
* Create a policy with the given global default requirements.
*
* @param defaultRequirements the global default requirements.
* @return a policy using the supplied requirements as its global default.
*/
public static ContainersPolicy of(List<PolicyRequirement> defaultRequirements) {
Objects.requireNonNull(defaultRequirements, "defaultRequirements");
return new ContainersPolicy(PolicyFile.fromJson(List.copyOf(defaultRequirements), null));
}

/**
* Load the containers policy from the standard locations.
*
Expand All @@ -90,7 +111,7 @@ public static ContainersPolicy newPolicy() {
}
}

LOG.warn("No containers policy.json found; using insecureAcceptAnything default");
LOG.debug("No containers policy.json found; using insecureAcceptAnything default");
return new ContainersPolicy(PolicyFile.fromJson(List.of(new PolicyRequirement.InsecureAcceptAnything()), null));
}

Expand Down
31 changes: 31 additions & 0 deletions src/test/java/land/oras/policy/ContainersPolicyTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import java.security.KeyPair;
import java.util.List;
import land.oras.EnvironmentLock;
import land.oras.Registry;
import land.oras.TestUtils;
import land.oras.exception.OrasException;
import org.junit.jupiter.api.Test;
Expand All @@ -44,6 +45,36 @@
@ResourceLock(providers = EnvironmentLock.class)
class ContainersPolicyTest {

@Test
void builderUsesSuppliedPolicy() {
ContainersPolicy supplied = ContainersPolicy.of(List.of(new PolicyRequirement.Reject()));

Registry registry = Registry.builder().withPolicy(supplied).build();

assertSame(supplied, registry.getContainersPolicy());
}

@Test
void acceptAnythingFactoryCreatesAcceptAllPolicy() {
ContainersPolicy policy = ContainersPolicy.acceptAnything();

assertEquals(1, policy.getDefaultRequirements().size());
assertInstanceOf(
PolicyRequirement.InsecureAcceptAnything.class,
policy.getDefaultRequirements().get(0));
assertTrue(policy.isAllowed(Transport.DOCKER, "registry.example.com/team/image"));
}

@Test
void ofFactoryCreatesPolicyFromDefaultRequirements() {
ContainersPolicy policy = ContainersPolicy.of(List.of(new PolicyRequirement.Reject()));

assertEquals(1, policy.getDefaultRequirements().size());
assertInstanceOf(
PolicyRequirement.Reject.class, policy.getDefaultRequirements().get(0));
assertFalse(policy.isAllowed(Transport.DOCKER, "registry.example.com/team/image"));
}

@Test
void loadAcceptAllFromFile() {
Path path = resourcePath("policy/accept-all.json");
Expand Down
Loading