docker-dspace-handle

A standalone handle server implementation for DSpace. It builds on:

• docker-handle
  • the above project provides a reference implementation only (no fork)
• Remote Handle Resolver
  • Patched Remote Handle Resolver

Refer to the DSpace wiki documentation handle.net integration for extended details.

Building the Remote Handle Resolver

The current release version of the handle resolver is out of date. See this PR for details: DSpace/Remote-Handle-Resolver#2

This repository provides an updated build at lib/dspace-remote-handle-resolver-1.1-SNAPSHOT.jar.

To re/create a build (requires Java / Maven):

1. Clone the repository

mkdir -p src
git -C src clone https://github.com/cnri/Remote-Handle-Resolver

2. Run a build

cd src/Remote-Handle-Resolver
mvn clean install -DskipTests
cd -
cp src/Remote-Handle-Resolver/target/dspace-remote-handle-resolver-1.1-SNAPSHOT.jar lib/

Build the Docker handle server image

docker compose build

Run the image locally for testing

docker compose up

DSpace plugin cfg

For local testing handle/config/handle-dspace-plugin.cfg is embedded with this repository. Using the envvar S3_HANDLE_DSPACE_PLUGIN_CFG_URL the file can be downloaded from s3 before the server starts.

When a new site is added this file will need to be updated, the handle server redeployed, and a handle prefix registration request will need to be made to the handle.net folks.

Re/generating keys

If keys needs to be regenerated the PRIVATE_KEY and PUBLIC_KEY need to be in pksc8 format:

ssh-keygen -m pkcs8 -f mykey.pem
# Get it in a format for PKCS8 and put in explicit new lines ready for env var
openssl pkcs8 -topk8 -in mykey.pem -nocrypt | sed ':a;N;$!ba;s/\n/\\r\\n/g'
openssl pkcs8 -topk8 -in mykey.pem -nocrypt | openssl pkey -pubout | sed ':a;N;$!ba;s/\n/\\r\\n/g'

For remote deployments the keys are uploaded to SSM:

• handle-private-key-pem
• handle-public-key-pem

sitebndl.zip

The sitebndl.zip is a collection if files that need to be submitted with handle prefix registration requests.

For local testing:

# the handle server must be running
docker compose up -d
make sitebndl # local server

The actual sitebndl.zip that would be submitted to handle.net should be generated on the running handle server instance.

This will only have to be done once (per handle server deployment).

Components of sitebndl:

• admpub.bin located in container at: /var/handle/svr/admpub.bin
• contactdata.dct located in container at: /var/handle/svr/contactdata.dct
• repl_admin located in container at: /var/handle/svr/repl_admin
• siteinfo.bin located in container at: /var/handle/svr/siteinfo.bin

The only relevant parts for DSpace/Direct (seemingly) are the siteinfo and contactdata.

When updating prefix assignments the same sitebndl.zip can be submitted each time as those details don't change with a standalone handle server.