Skip to content

authhelper: skip logout statements in CSA #6518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

authhelper: skip logout statements in CSA #6518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions addOns/authhelper/src/main/java/org/zaproxy/addon/authhelper/AuthUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@
import org.zaproxy.zap.users.User;
import org.zaproxy.zap.utils.Pair;
import org.zaproxy.zap.utils.Stats;
import org.zaproxy.zest.core.v1.ZestComment;
import org.zaproxy.zest.core.v1.ZestScript;
import org.zaproxy.zest.core.v1.ZestStatement;

public class AuthUtils {

Expand Down Expand Up @@ -146,6 +149,8 @@ public class AuthUtils {

private static final String INPUT_TAG = "input";

private static final String RECORDING_LOGOUT = "ZAP Recording LOGOUT";

private static final HttpRequestConfig REDIRECT_NOTIFIER_CONFIG =
HttpRequestConfig.builder()
.setRedirectionValidator(
Expand Down Expand Up @@ -1362,4 +1367,16 @@ public static boolean isRelevantToAuthDiags(HttpMessage msg) {
|| host.contains("mozilla")
|| host.contains("safebrowsing-cache"));
}

public static void disableLogoutStatements(ZestScript zestScript) {
boolean disable = false;
for (ZestStatement stmt : zestScript.getStatements()) {
if (disable) {
stmt.setEnabled(false);
} else if (stmt instanceof ZestComment comment
&& RECORDING_LOGOUT.equals(comment.getComment())) {
disable = true;
}
}
}
}
2 changes: 1 addition & 1 deletion addOns/authhelper/src/main/java/org/zaproxy/addon/authhelper/AuthenticationDiagnostics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ public void insertDiagnostics(ZestScript zestScript) {

for (int i = 0; i < zestScript.getStatements().size(); i++) {
ZestStatement stmt = zestScript.getStatements().get(i);
if (stmt instanceof ZestClientElementClear) {
if (!stmt.isEnabled() || stmt instanceof ZestClientElementClear) {
continue;
}

Expand Down
1 change: 1 addition & 0 deletions ...src/main/java/org/zaproxy/addon/authhelper/ClientScriptBasedAuthenticationMethodType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,7 @@ public WebSession authenticate(
zestScript.add(
new ZestActionSleep(TimeUnit.SECONDS.toMillis(getLoginPageWait())));
removeCloseStatements(zestScript);
AuthUtils.disableLogoutStatements(zestScript);
} else {
LOGGER.warn("Expected authScript to be a Zest script");
return null;
Expand Down
1 change: 1 addition & 0 deletions ...helper/src/main/java/org/zaproxy/addon/authhelper/internal/AuthenticationBrowserHook.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ public void browserLaunched(SeleniumScriptUtils ssUtils) {
paramsValues.put(USERNAME, credentials.getParam(USERNAME));
paramsValues.put(PASSWORD, credentials.getParam(PASSWORD));
ZestScript zs = csaMethod.getZestScript();
AuthUtils.disableLogoutStatements(zs);
runner.setup(user, zs);
runner.run(zs, paramsValues);

Expand Down
40 changes: 40 additions & 0 deletions addOns/authhelper/src/test/java/org/zaproxy/addon/authhelper/AuthUtilsUnitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@
import org.zaproxy.zap.testutils.TestUtils;
import org.zaproxy.zap.users.User;
import org.zaproxy.zap.utils.Pair;
import org.zaproxy.zest.core.v1.ZestActionPrint;
import org.zaproxy.zest.core.v1.ZestComment;
import org.zaproxy.zest.core.v1.ZestScript;

class AuthUtilsUnitTest extends TestUtils {

Expand Down Expand Up @@ -983,6 +986,43 @@ void shouldReportRelevantResponseHeaderTypeToAuthDiags(String type, String resul
assertThat(res, is(equalTo(Boolean.parseBoolean(result))));
}

@Test
void shouldDisableLogoutStatements() {
// Given
ZestScript zs = new ZestScript();
zs.add(new ZestActionPrint());
zs.add(new ZestActionPrint());
zs.add(new ZestComment("ZAP Recording LOGOUT"));
zs.add(new ZestActionPrint());
zs.add(new ZestActionPrint());

// When
AuthUtils.disableLogoutStatements(zs);

// Then
assertThat(zs.getStatements().get(0).isEnabled(), is(equalTo(true)));
assertThat(zs.getStatements().get(1).isEnabled(), is(equalTo(true)));
assertThat(zs.getStatements().get(2).isEnabled(), is(equalTo(true)));
assertThat(zs.getStatements().get(3).isEnabled(), is(equalTo(false)));
assertThat(zs.getStatements().get(4).isEnabled(), is(equalTo(false)));
}

@Test
void shouldNotDisableStatementsWhenNoLogoutCommentPresent() {
// Given
ZestScript zs = new ZestScript();
zs.add(new ZestActionPrint());
zs.add(new ZestActionPrint());
zs.add(new ZestActionPrint());
zs.add(new ZestActionPrint());

// When
AuthUtils.disableLogoutStatements(zs);

// Then
zs.getStatements().forEach(e -> assertThat(e.isEnabled(), is(equalTo(true))));
}

static class BrowserTest extends TestUtils {

private static final String HTML_SHADOM_DOM =
Expand Down