Skip to content

Commit

Permalink
chore: Improve action validation failure messages
Browse files Browse the repository at this point in the history
  • Loading branch information
@rsenden
rsenden committed May 14, 2024
1 parent c9d75db commit bf00ff6
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 44 deletions.
82 changes: 42 additions & 40 deletions ...re/fcli-common/src/main/java/com/fortify/cli/common/action/helper/ActionLoaderHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.List;
import java.util.Map;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Supplier;
import java.util.regex.Pattern;
Expand Down Expand Up @@ -82,13 +83,14 @@ private static final Stream<ObjectNode> _streamAsJson(List<ActionSource> sources
.sorted((a,b)->a.get("name").asText().compareTo(b.get("name").asText()));
}

public static final String getSignatureStatusMessage(SignatureStatus signatureStatus) {
public static final String getSignatureStatusMessage(ActionProperties properties, SignatureStatus signatureStatus) {
var name = properties.getName();
switch (signatureStatus) {
case INVALID_SIGNATURE: return "Action signature is invalid.";
case NO_PUBLIC_KEY: return "No trusted public key found to verify action signature.";
case NO_SIGNATURE: return "Action is not signed.";
case NOT_VERIFIED: return "Action signature verification skipped.";
case VALID_SIGNATURE: return "Action has a valid signature.";
case INVALID_SIGNATURE: return "Signature for action "+name+" is invalid.";
case NO_PUBLIC_KEY: return "No trusted public key found to verify "+name+" action signature.";
case NO_SIGNATURE: return "Action "+name+" is not signed.";
case NOT_VERIFIED: return "Signature verification skipped for action "+name+".";
case VALID_SIGNATURE: return "Action "+name+" has a valid signature.";
default: throw new RuntimeException("Unknown signature status: "+signatureStatus);
}
}
Expand Down Expand Up @@ -173,16 +175,16 @@ private final ActionLoadResult load(ZipInputStream zis, ZipEntry ze, ActionPrope
}

final ActionLoadResult load(InputStream is, ActionProperties properties) {
return new ActionLoadResult(actionValidationHandler, loadSignedTextDescriptor(is, properties.isCustom()), properties);
return new ActionLoadResult(actionValidationHandler, loadSignedTextDescriptor(properties, is), properties);
}

private final SignedTextDescriptor loadSignedTextDescriptor(InputStream is, boolean isCustom) {
private final SignedTextDescriptor loadSignedTextDescriptor(ActionProperties properties, InputStream is) {
return signedTextReader.load(is, StandardCharsets.UTF_8,
// TODO For now, we only evaluate/check signatures for custom actions,
// until we've figured out how to sign internal actions during (or
// potentially after) Gradle build.
isCustom
? actionValidationHandler.getSignatureValidator()
properties.isCustom()
? actionValidationHandler.getSignatureValidator(properties)
: null);
}

Expand Down Expand Up @@ -265,7 +267,7 @@ private final String updateSchema(String actionText) {
}
var schemaVersion = ActionSchemaHelper.getSchemaVersion(schemaUri);
if ( !ActionSchemaHelper.isSupportedSchemaVersion(schemaVersion) ) {
actionValidationHandler.onUnsupportedSchemaVersion(schemaVersion);
actionValidationHandler.onUnsupportedSchemaVersion(properties, schemaVersion);
}
return result;
}
Expand Down Expand Up @@ -399,55 +401,55 @@ public static final class ActionValidationHandler {
.onUnsupportedSchemaVersion(ActionInvalidSchemaVersionHandler.ignore)
.build();
@Singular private final List<String> extraPublicKeys;
@Singular private final Map<SignatureStatus, Consumer<SignedTextDescriptor>> onSignatureStatuses;
@Builder.Default private final Consumer<SignedTextDescriptor> onSignatureStatusDefault = ActionInvalidSignatureHandler.prompt;
@Builder.Default private final Consumer<String> onUnsupportedSchemaVersion = ActionInvalidSchemaVersionHandler.prompt;
@Singular private final Map<SignatureStatus, BiConsumer<ActionProperties, SignedTextDescriptor>> onSignatureStatuses;
@Builder.Default private final BiConsumer<ActionProperties, SignedTextDescriptor> onSignatureStatusDefault = ActionInvalidSignatureHandler.prompt;
@Builder.Default private final BiConsumer<ActionProperties, String> onUnsupportedSchemaVersion = ActionInvalidSchemaVersionHandler.prompt;

public final SignatureValidator getSignatureValidator() {
return new SignatureValidator(this::handleInvalidSignature, extraPublicKeys.toArray(String[]::new));
public final SignatureValidator getSignatureValidator(ActionProperties properties) {
return new SignatureValidator(d->handleInvalidSignature(properties, d), extraPublicKeys.toArray(String[]::new));
}
public final void onUnsupportedSchemaVersion(String schemaVersion) {
this.onUnsupportedSchemaVersion.accept(schemaVersion);
public final void onUnsupportedSchemaVersion(ActionProperties properties, String schemaVersion) {
this.onUnsupportedSchemaVersion.accept(properties, schemaVersion);
}
private final void handleInvalidSignature(SignedTextDescriptor signedTextDescriptor) {
private final void handleInvalidSignature(ActionProperties properties, SignedTextDescriptor signedTextDescriptor) {
var consumer = onSignatureStatuses.get(signedTextDescriptor.getSignatureStatus());
if ( consumer==null ) { consumer = onSignatureStatusDefault; }
consumer.accept(signedTextDescriptor);
consumer.accept(properties, signedTextDescriptor);
}

@RequiredArgsConstructor
public static enum ActionInvalidSignatureHandler implements Consumer<SignedTextDescriptor> {
ignore(d->{}),
warn(d->_warn(signatureFailureMessage(d))),
fail(d->_throw(signatureFailureMessage(d))),
prompt(d->_prompt(signatureFailureMessage(d)));
private final Consumer<SignedTextDescriptor> onInvalidSignature;
public static enum ActionInvalidSignatureHandler implements BiConsumer<ActionProperties, SignedTextDescriptor> {
ignore((p,d)->{}),
warn((p,d)->_warn(signatureFailureMessage(p,d))),
fail((p,d)->_throw(signatureFailureMessage(p,d))),
prompt((p,d)->_prompt(signatureFailureMessage(p,d)));
private final BiConsumer<ActionProperties, SignedTextDescriptor> onInvalidSignature;

@Override
public void accept(SignedTextDescriptor descriptor) {
onInvalidSignature.accept(descriptor);
public void accept(ActionProperties properties, SignedTextDescriptor descriptor) {
onInvalidSignature.accept(properties, descriptor);
}

private static final String signatureFailureMessage(SignedTextDescriptor descriptor) {
return getSignatureStatusMessage(descriptor.getSignatureStatus());
private static final String signatureFailureMessage(ActionProperties properties, SignedTextDescriptor descriptor) {
return getSignatureStatusMessage(properties, descriptor.getSignatureStatus());
}
}

@RequiredArgsConstructor
public static enum ActionInvalidSchemaVersionHandler implements Consumer<String> {
ignore(v->{}),
warn(v->_warn(unsupportedSchemaMessage(v))),
fail(v->_throw(unsupportedSchemaMessage(v))),
prompt(v->_prompt(unsupportedSchemaMessage(v)));
private final Consumer<String> onInvalidSchemaVersion;
public static enum ActionInvalidSchemaVersionHandler implements BiConsumer<ActionProperties, String> {
ignore((p,v)->{}),
warn((p,v)->_warn(unsupportedSchemaMessage(p,v))),
fail((p,v)->_throw(unsupportedSchemaMessage(p,v))),
prompt((p,v)->_prompt(unsupportedSchemaMessage(p,v)));
private final BiConsumer<ActionProperties, String> onInvalidSchemaVersion;

@Override
public void accept(String schemaVersion) {
onInvalidSchemaVersion.accept(schemaVersion);
public void accept(ActionProperties properties, String schemaVersion) {
onInvalidSchemaVersion.accept(properties, schemaVersion);
}

public static final String unsupportedSchemaMessage(String unsupportedVersion) {
return String.format("Action uses unsupported schema version %s and may fail.", unsupportedVersion);
public static final String unsupportedSchemaMessage(ActionProperties properties, String unsupportedVersion) {
return String.format("Action "+properties.getName()+" uses unsupported schema version %s and may fail.", unsupportedVersion);
}
}

Expand Down
5 changes: 3 additions & 2 deletions fcli-core/fcli-fod/src/test/java/com/fortify/cli/fod/_common/action/AbstractActionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
*/
package com.fortify.cli.fod._common.action;

import java.util.function.Consumer;
import java.util.function.BiConsumer;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.TestInstance;
Expand All @@ -25,6 +25,7 @@
import com.fortify.cli.common.action.helper.ActionLoaderHelper.ActionValidationHandler;
import com.fortify.cli.common.action.helper.ActionLoaderHelper.ActionValidationHandler.ActionInvalidSchemaVersionHandler;
import com.fortify.cli.common.action.helper.ActionLoaderHelper.ActionValidationHandler.ActionInvalidSignatureHandler;
import com.fortify.cli.common.action.model.Action.ActionProperties;
import com.fortify.cli.common.crypto.helper.SignatureHelper.SignedTextDescriptor;

// TODO Move this class to a common test utility module; currently
Expand Down Expand Up @@ -55,7 +56,7 @@ public final String[] getActions() {
.toArray(String[]::new);
}

private static final Consumer<SignedTextDescriptor> invalidSignatureHandler() {
private static final BiConsumer<ActionProperties, SignedTextDescriptor> invalidSignatureHandler() {
return "true".equalsIgnoreCase((System.getProperty("test.action.requireValidSignature")))
? ActionInvalidSignatureHandler.fail
: ActionInvalidSignatureHandler.warn;
Expand Down
5 changes: 3 additions & 2 deletions fcli-core/fcli-ssc/src/test/java/com/fortify/cli/ssc/_common/action/AbstractActionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
*/
package com.fortify.cli.ssc._common.action;

import java.util.function.Consumer;
import java.util.function.BiConsumer;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.TestInstance;
Expand All @@ -25,6 +25,7 @@
import com.fortify.cli.common.action.helper.ActionLoaderHelper.ActionValidationHandler;
import com.fortify.cli.common.action.helper.ActionLoaderHelper.ActionValidationHandler.ActionInvalidSchemaVersionHandler;
import com.fortify.cli.common.action.helper.ActionLoaderHelper.ActionValidationHandler.ActionInvalidSignatureHandler;
import com.fortify.cli.common.action.model.Action.ActionProperties;
import com.fortify.cli.common.crypto.helper.SignatureHelper.SignedTextDescriptor;

// TODO Move this class to a common test utility module; currently
Expand Down Expand Up @@ -55,7 +56,7 @@ public final String[] getActions() {
.toArray(String[]::new);
}

private static final Consumer<SignedTextDescriptor> invalidSignatureHandler() {
private static final BiConsumer<ActionProperties, SignedTextDescriptor> invalidSignatureHandler() {
return "true".equalsIgnoreCase((System.getProperty("test.action.requireValidSignature")))
? ActionInvalidSignatureHandler.fail
: ActionInvalidSignatureHandler.warn;
Expand Down

0 comments on commit bf00ff6

Please sign in to comment.