Skip to content

Remove ProcessOpenID and openid4java dependency #28

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

Merged
kal merged 2 commits into from
Apr 29, 2026
Merged

Remove ProcessOpenID and openid4java dependency #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d8cdfd
Remove ProcessOpenID and openid4java dependency
kal Apr 28, 2026
a09ecba
Update documentation and changelog to reflect removal of OpenID support
kal Apr 29, 2026
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
15 changes: 15 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

### Removed

* Removed support for authentication via the now deprecated OpenID 1.0 / OpenID 2.0 protocols.

## [4.1.3] - 2026-04-28

Expand All @@ -20,3 +23,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* Update transitive dependency on org.bouncycastle:bcprov-jdk18on to 1.84 to address dependabot-reported vulnerabilities.

## [4.0.0] - 2025-12-16

* Move from Java 11 to 21
* Update appbase dependency to 4.0.0
* Update derby 10.14 -> 10.17
* Move from javax.servlet -> jakarta.servlet 6.0

## [3.0.3] - 2025-07-24

* Update shiro to 1.13.0 to avoid most severe CVEs. Move to Shiro2.x would be breaking and there's no migration documentation.
* Update appbase dependency to pull in update to tomcat 9.0

126 changes: 2 additions & 124 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,10 @@ appbase-security
* Provides a `UserStore` for holding registered users and associated permissions, optionally including password credentials. Includes a database-backed store based on embedded [Derby](https://db.apache.org/derby/) and a memory based implementation which is loaded from a configuration file.
* Provides a Realm implementation which has an associated `UserStore` and allows authentication tokens which are externally validated.
* Permissions structure is based on Shiro Wildcard permissions but assumes a simplified pattern of `"{action}:{location}"`. Permissions can be retrieved by location as well as by user.
* Provides packaged access to an [OpenID](http://openid.net/) implementation so it's easy to create applications where you can register and login using OpenID such as Google.

## Change log:

**4.0.0**
* Move from Java 11 to 21
* Update appbase dependency to 4.0.0
* Update derby 10.14 -> 10.17
* Move from javax.servlet -> jakarta.servlet 6.0

**3.0.3**
* Update shiro to 1.13.0 to avoid most severe CVEs. Move to Shiro2.x would be breaking and there's no migration documentation.
* Update appbase dependency to pull in update to tomcat 9.0
See the separate [CHANGELOG.md](CHANGELOG.md).

## Usage

Expand Down Expand Up @@ -157,18 +148,10 @@ user id "name" password
For example:

```INI
user https://profiles.google.com/1147194443288764760228 "Alice"
user dave@epimorphics.com "Dave Reynolds" shouldbechanged
```

An OpenID profile for anyone with a Google account can be obtained from their profile or
Google-plus home page and copying the long number from there into the above URL pattern.
A general Google login generates an OpenID which depends on the requesting web site
as well as the user. To determine the ID in that case start the bootstrap registry,
register the target user and note the resulting OpenID, then shutdown the registry
and modify the initialization file accordingly.

There is a built-in anonymous user with pseudo OpenID of `http://localhost/anon`.
There is a built-in anonymous user with pseudo id of `http://localhost/anon`.
It is convenient to declare that user in the initialization file as well, so as to bind a
visible name to that id. For example:

Expand Down Expand Up @@ -267,111 +250,6 @@ public class SecurityViolationMapper implements
}
```

## OpenID, login and registration

The `Login` class provides a set of convenience methods to enable user registration
and login via OpenID, login via password credentials and logout.

To use this you need to provide a set of URL endpoints which invoke the various actions
and handle OpenID response processing. The easy way to do this is via
[Jersey](https://jersey.java.net/index.html). For example:

```java
@Path("/system/security")
public class LoginCmds {
protected @Context UriInfo uriInfo;
protected @Context ServletContext context;

// request OpenID login for a registered user
@Path("/login")
@POST
public Response login(
@FormParam("provider") String provider,
@FormParam("return") String returnURL,
@Context HttpServletRequest request,
@Context HttpServletResponse response) {
OpenidRequest oid = new OpenidRequest(uriInfo.getBaseUri().toString() +
"system/security/response");
oid.setProvider(provider);
oid.setReturnURL(returnURL);
try {
processOpenID(request, response, oid);
} catch (Exception e) {
throw new WebApiException(Status.BAD_REQUEST,
"Login/registration action failed: " + e);
}
return Response.ok().build();
}

// Register a new user via OpenID
@Path("/register")
@POST
public Response register(
@FormParam("provider") String provider,
@FormParam("return") String returnURL,
@Context HttpServletRequest request,
@Context HttpServletResponse response) {
OpenidRequest oid = new OpenidRequest(uriInfo.getBaseUri().toString() +
"system/security/response");
oid.setProvider(provider);
oid.setReturnURL(returnURL);
oid.setRegister(true);
try {
processOpenID(request, response, oid);
} catch (Exception e) {
throw new WebApiException(Status.BAD_REQUEST,
"Login/registration action failed: " + e);
}
return Response.ok().build();
}

// Logout the current loged in user
@Path("/logout")
@POST
public void doLogout(@Context HttpServletRequest request,
@Context HttpServletResponse response) throws IOException {
logout(request);
response.sendRedirect(request.getServletContext().getContextPath());
}

// Internal endpoint use in the OpenID handshake
@Path("/response")
@GET
public Response openIDResponse(@Context HttpServletRequest request,
@Context HttpServletResponse response) {
try {
UserStore userstore = AppConfig.getApp()
.getComponentAs("userstore", UserStore.class);
return redirectTo( verifyResponse(request, response, userstore) );
} catch (Exception e) {
return renderError( e.getMessage() );
}
}

private Response redirectTo(String path) {
URI uri;
try {
uri = new URI(path);
return Response.seeOther(uri).build();
} catch (URISyntaxException e) {
throw new EpiException(e);
}
}

// Some means to report login errors, this assumes AppBase velocity rendering using a generic error.vm template
private Response renderError(String message) {
VelocityRender velocity = AppConfig.getApp()
.getComponentAs("velocity", VelocityRender.class);
StreamingOutput out = velocity.render("error.vm",
uriInfo.getPath(),
context,
uriInfo.getQueryParameters(),
"message", message);
return Response.status(Status.BAD_REQUEST).entity(out).build();
}
}
```

## Other

The `UserStore` implementation also provides various methods for accessing available
Expand Down
34 changes: 0 additions & 34 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,40 +107,6 @@
<version>3.20.0</version>
</dependency>

<dependency>
<groupId>org.openid4java</groupId>
<artifactId>openid4java</artifactId>
<version>1.0.0</version>
<exclusions>
<exclusion>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
</exclusion>
<exclusion>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpcore</artifactId>
</exclusion>
<exclusion>
<groupId>xerces</groupId>
<artifactId>xercesImpl</artifactId>
</exclusion>
<exclusion>
<groupId>net.sourceforge.nekohtml</groupId>
<artifactId>nekohtml</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>xerces</groupId>
<artifactId>xercesImpl</artifactId>
<version>2.12.2</version>
</dependency>
<dependency>
<groupId>net.sourceforge.nekohtml</groupId>
<artifactId>nekohtml</artifactId>
<version>1.9.22</version>
</dependency>

<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-core</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/epimorphics/appbase/security/Login.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
import com.epimorphics.util.EpiException;

/**
* Utility functions for registration and login via OpenID.
* Utility functions for registration and login.
* Binding these to resource URIs via jersey in the web application.
*
* @author <a href="mailto:dave@epimorphics.com">Dave Reynolds</a>
Expand Down
Loading
Loading