Skip to content
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

Bugfix/xhr allow authorization header #670

Merged
merged 6 commits into from
Sep 25, 2024
Merged

Bugfix/xhr allow authorization header #670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c3a6e9a
Allow sending info.json XHR with Authorization header (#574)
Mar 25, 2022
cbee165
Merge branch 'develop' into bugfix/xhr-allow-authorization-header
ksclarke Aug 16, 2024
209cf94
Merge branch 'develop' into bugfix/xhr-allow-authorization-header
ksclarke Aug 28, 2024
b6236e7
Merge branch 'develop' into bugfix/xhr-allow-authorization-header
ksclarke Sep 10, 2024
fe5c06e
Merge branch 'develop' into bugfix/xhr-allow-authorization-header
ksclarke Sep 11, 2024
a4d7dc1
Merge branch 'develop' into bugfix/xhr-allow-authorization-header
ksclarke Sep 11, 2024
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
5 changes: 4 additions & 1 deletion src/main/java/edu/illinois/library/cantaloupe/resource/AbstractResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,10 @@ public void doHEAD() throws Exception {
doGET();
}

final void doOPTIONS() {
/**
* May be overridden by implementations that support {@literal OPTIONS}.
*/
protected void doOPTIONS() {
Method[] methods = getSupportedMethods();
if (methods.length > 0) {
response.setStatus(Status.NO_CONTENT.getCode());
Expand Down
19 changes: 19 additions & 0 deletions src/main/java/edu/illinois/library/cantaloupe/resource/iiif/v1/InformationResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
package edu.illinois.library.cantaloupe.resource.iiif.v1;

import java.util.Arrays;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import edu.illinois.library.cantaloupe.http.Method;
import edu.illinois.library.cantaloupe.http.Status;
Expand All @@ -18,6 +20,8 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import jakarta.servlet.http.HttpServletResponse;

/**
* Handles IIIF Image API 1.x information requests.
*
Expand All @@ -42,6 +46,21 @@ public Method[] getSupportedMethods() {
return SUPPORTED_METHODS;
}

@Override
protected final void doOPTIONS() {
ksclarke marked this conversation as resolved.
Show resolved Hide resolved
HttpServletResponse response = getResponse();
Method[] methods = getSupportedMethods();
if (methods.length > 0) {
response.setStatus(Status.NO_CONTENT.getCode());
response.setHeader("Access-Control-Allow-Headers", "Authorization");
response.setHeader("Allow", Arrays.stream(methods)
.map(Method::toString)
.collect(Collectors.joining(",")));
} else {
response.setStatus(Status.METHOD_NOT_ALLOWED.getCode());
}
}

/**
* Writes a JSON-serialized {@link Information} instance to the response.
*/
Expand Down
18 changes: 18 additions & 0 deletions src/main/java/edu/illinois/library/cantaloupe/resource/iiif/v2/InformationResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
package edu.illinois.library.cantaloupe.resource.iiif.v2;

import java.util.Arrays;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import edu.illinois.library.cantaloupe.http.Method;
import edu.illinois.library.cantaloupe.http.Status;
Expand All @@ -20,6 +22,7 @@
import org.slf4j.LoggerFactory;

import javax.script.ScriptException;
import jakarta.servlet.http.HttpServletResponse;

/**
* Handles information requests.
Expand All @@ -45,6 +48,21 @@ public Method[] getSupportedMethods() {
return SUPPORTED_METHODS;
}

@Override
protected final void doOPTIONS() {
HttpServletResponse response = getResponse();
Method[] methods = getSupportedMethods();
if (methods.length > 0) {
response.setStatus(Status.NO_CONTENT.getCode());
response.setHeader("Access-Control-Allow-Headers", "Authorization");
response.setHeader("Allow", Arrays.stream(methods)
.map(Method::toString)
.collect(Collectors.joining(",")));
} else {
response.setStatus(Status.METHOD_NOT_ALLOWED.getCode());
}
}

/**
* Writes a JSON-serialized {@link Information} instance to the response.
*/
Expand Down
18 changes: 18 additions & 0 deletions src/main/java/edu/illinois/library/cantaloupe/resource/iiif/v3/InformationResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
package edu.illinois.library.cantaloupe.resource.iiif.v3;

import java.util.Arrays;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import edu.illinois.library.cantaloupe.http.Method;
import edu.illinois.library.cantaloupe.http.Status;
Expand All @@ -20,6 +22,7 @@
import org.slf4j.LoggerFactory;

import javax.script.ScriptException;
import jakarta.servlet.http.HttpServletResponse;

/**
* Handles IIIF Image API 3.x information requests.
Expand All @@ -45,6 +48,21 @@ public Method[] getSupportedMethods() {
return SUPPORTED_METHODS;
}

@Override
protected final void doOPTIONS() {
HttpServletResponse response = getResponse();
Method[] methods = getSupportedMethods();
if (methods.length > 0) {
response.setStatus(Status.NO_CONTENT.getCode());
response.setHeader("Access-Control-Allow-Headers", "Authorization");
response.setHeader("Allow", Arrays.stream(methods)
.map(Method::toString)
.collect(Collectors.joining(",")));
} else {
response.setStatus(Status.METHOD_NOT_ALLOWED.getCode());
}
}

/**
* Writes a JSON-serialized {@link Information} instance to the response.
*/
Expand Down
5 changes: 5 additions & 0 deletions src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v1/InformationResourceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,11 @@ void testOPTIONSWhenEnabled() throws Exception {
assertEquals(2, methods.size());
assertTrue(methods.contains("GET"));
assertTrue(methods.contains("OPTIONS"));

List<String> allowedHeaders =
List.of(StringUtils.split(headers.getFirstValue("Access-Control-Allow-Headers"), ", "));
assertEquals(1, allowedHeaders.size());
assertTrue(allowedHeaders.contains("Authorization"));
}

@Test
Expand Down
5 changes: 5 additions & 0 deletions src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v2/InformationResourceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,6 +623,11 @@ void testOPTIONSWhenEnabled() throws Exception {
assertEquals(2, methods.size());
assertTrue(methods.contains("GET"));
assertTrue(methods.contains("OPTIONS"));

List<String> allowedHeaders =
List.of(StringUtils.split(headers.getFirstValue("Access-Control-Allow-Headers"), ", "));
assertEquals(1, allowedHeaders.size());
assertTrue(allowedHeaders.contains("Authorization"));
}

@Test
Expand Down
5 changes: 5 additions & 0 deletions src/test/java/edu/illinois/library/cantaloupe/resource/iiif/v3/InformationResourceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -600,6 +600,11 @@ void testOPTIONSWhenEnabled() throws Exception {
assertEquals(2, methods.size());
assertTrue(methods.contains("GET"));
assertTrue(methods.contains("OPTIONS"));

List<String> allowedHeaders =
List.of(StringUtils.split(headers.getFirstValue("Access-Control-Allow-Headers"), ", "));
assertEquals(1, allowedHeaders.size());
assertTrue(allowedHeaders.contains("Authorization"));
}

@Test
Expand Down