Compare commits

..
Author SHA1 Message Date
Connor Yoh f603ba12ce personal certs working 2026-01-20 10:26:54 +00:00
Connor Yoh da80344c08 Demo of wet signature bad ui 2026-01-20 09:56:35 +00:00
Connor Yoh ffd404a24b User signing 2026-01-15 18:00:46 +00:00
Connor Yoh f2eee030c3 Working for sessions 2025-12-03 16:41:56 +00:00
Connor Yoh ce10dacf15 Working with sessions and Database 2025-12-02 21:13:28 +00:00
Connor Yoh 60e2a67200 json mode 2025-12-02 15:14:16 +00:00
Connor YohandClaude 3e87faf07e Complete shared signing workflow implementation
**Backend fixes:**
- SigningSessionController: Gracefully skip SERVER certificate type when feature unavailable
- Change createSession endpoint to return ResponseEntity<SigningSession> with JSON content type
- Prevents errors in non-proprietary/unlicensed deployments

**Frontend enhancements:**
- SigningWorkflow: Auto-detect JSON session files and skip to finalization
- Add JSON file support to tool registry (supportedFormats: pdf, json)
- Enable session owners to re-upload JSON and finalize without recreating
- Debug logging for troubleshooting session detection

**Routing:**
- Core App.tsx: Add query param detection for participant URLs
- Proprietary App.tsx: Add /signing-session route with React Router integration
- Both apps now support: /signing-session?sessionId={id}&token={token}

**Complete end-to-end workflow:**
1. Owner creates session → downloads JSON with participant tokens
2. Participants access unique URLs → submit certificates (PEM/PKCS12/PFX/JKS)
3. Owner re-uploads JSON → clicks finalize → downloads signed PDF
4. SERVER certificate type gracefully skipped when feature unavailable

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-02 13:49:22 +00:00
Connor YohandClaude 3b64da76ff Add session finalization with PDF download
**SigningWorkflow.tsx enhancements:**
- Add finalization state management (loading, error)
- Extract sessionId from result JSON file asynchronously
- Finalization handler calls /finalize endpoint with extracted sessionId
- Auto-download signed PDF on success
- Display finalization button in review section when results present
- Show helpful tooltip explaining finalization process
- Error handling with user-friendly messages

**User flow:**
1. User creates session → receives signing-session-{id}.json
2. Shares participant URLs (from JSON)
3. Participants submit certificates via their URLs
4. User returns to tool with JSON file
5. Clicks "Finalize and download signed PDF"
6. Backend applies all signatures in order
7. Signed PDF auto-downloads

**UI components:**
- Alert with finalization tooltip (blue)
- Green finalization button with CheckCircle icon
- Error alert if finalization fails (red)
- Loading state during API call

**API:**
- POST /api/v1/security/cert-sign/sessions/{sessionId}/finalize
- Response: Binary PDF blob
- Downloads as: signed-{sessionId}.pdf

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-02 11:11:29 +00:00
Connor YohandClaude ffbecc592b Add participant certificate submission UI
**New component:** ParticipantCertificateSubmission.tsx
- Standalone page for participants to submit certificates via shareToken URL
- URL pattern: /signing-session?sessionId={uuid}&token={shareToken}
- Validates token against session participants
- Supports all certificate types: PEM, PKCS12, PFX, JKS, SERVER
- Configurable signature appearance (visible/invisible, page, reason, location, name, logo)
- Error handling for invalid tokens, already signed, and API failures
- Success state with confirmation message

**App.tsx routing:**
- Check query params for sessionId + token on load
- Route to participant submission page if both present
- Otherwise show normal home page
- No React Router dependency (simple query param parsing)

**Integration:**
- Uses existing FileUploadButton component
- Follows Mantine UI patterns from SigningCollaborationSettings
- API: POST /api/v1/security/cert-sign/sessions/{sessionId}/participants/{email}/certificate

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-02 10:49:39 +00:00
Connor YohandClaude 2e3e297e07 Add shared signing translation keys (en-GB only)
- Add home.signingWorkflow.* keys for tool registration
- Add certSign.collab.* keys for session creation UI
- Add certSign.collab.participant.* keys for certificate submission page
- Add certSign.collab.finalize.* keys for finalization button
- Total: 35+ new translation keys
- Follows project convention: en-GB only (not en-US)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-02 10:48:53 +00:00
Connor YohandClaude b9d68ccfdd Remove offline dependency mirror configuration
- Remove local-maven repository from build.gradle and settings.gradle
- Delete local-maven directory with cached POM files
- Preserve dependency version updates and plugin removals from original commit
- Build verified to work without offline mirror

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-02 10:48:32 +00:00
ConnorYoh a9bc7a562d Fix build with offline dependency mirror 2025-12-01 18:07:42 +00:00
ConnorYoh efbb45717b Add shared signing user stories 2025-11-28 16:13:26 +00:00
James BruntonandGitHub 731743b618 Don't block desktop app on backend starting up (#5041)
# Description of Changes
Start bundled backend instantly on startup of app and don't wait on it
being fully up to spawn app. This is techincally wasteful curently on
self-hosted mode where everything runs remotely, but in the future we'll
probably route simple operations to the local machine regardless of
connection, and it stops unnecessary waiting in the offline mode.
2025-11-27 15:54:35 +00:00
ConnorYohandGitHub 04c4aec0d8 Disable admin plan section when no login (#5039)
Admin plan section matches other admin sections

<img width="1013" height="629" alt="image"
src="https://github.com/user-attachments/assets/39e9fad7-461c-491d-99cb-4b140292f2f4"
/>
<img width="730" height="595" alt="image"
src="https://github.com/user-attachments/assets/b26354d2-5401-40b3-8ca7-3b48b26b644e"
/>
2025-11-27 13:57:04 +00:00
Anthony StirlingandGitHub f63df148ad Create LICENSE 2025-11-27 11:14:15 +00:00
Anthony StirlingandGitHub 6f0be94bd6 Update LICENSE with proprietary directory details
Added licensing information for proprietary directories.
2025-11-27 11:11:53 +00:00
Anthony StirlingandGitHub e47ed13be8 Builds custom Jar (#5029)
# Description of Changes

Change jar files to contain frontend if provided with param, else
doesnt... add release artifact -server version which wont have frontend

---

## Checklist

### General

- [ ] I have read the [Contribution
Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
- [ ] I have read the [Stirling-PDF Developer
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md)
(if applicable)
- [ ] I have read the [How to add new languages to
Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md)
(if applicable)
- [ ] I have performed a self-review of my own code
- [ ] My changes generate no new warnings

### Documentation

- [ ] I have updated relevant docs on [Stirling-PDF's doc
repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/)
(if functionality has heavily changed)
- [ ] I have read the section [Add New Translation
Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags)
(for new translation tags only)

### Translations (if applicable)

- [ ] I ran
[`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md)

### UI Changes (if applicable)

- [ ] Screenshots or videos demonstrating the UI changes are attached
(e.g., as comments or direct attachments in the PR)

### Testing (if applicable)

- [ ] I have tested my changes locally. Refer to the [Testing
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing)
for more details.
2025-11-26 17:21:42 +00:00
Reece BrowneandGitHub a62c8b54cf Chore/v2/hide banner in onboard (#5032)
# Description of Changes

<!--
Please provide a summary of the changes, including:

- What was changed
- Why the change was made
- Any challenges encountered

Closes #(issue_number)
-->

---

## Checklist

### General

- [ ] I have read the [Contribution
Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
- [ ] I have read the [Stirling-PDF Developer
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md)
(if applicable)
- [ ] I have read the [How to add new languages to
Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md)
(if applicable)
- [ ] I have performed a self-review of my own code
- [ ] My changes generate no new warnings

### Documentation

- [ ] I have updated relevant docs on [Stirling-PDF's doc
repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/)
(if functionality has heavily changed)
- [ ] I have read the section [Add New Translation
Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags)
(for new translation tags only)

### Translations (if applicable)

- [ ] I ran
[`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md)

### UI Changes (if applicable)

- [ ] Screenshots or videos demonstrating the UI changes are attached
(e.g., as comments or direct attachments in the PR)

### Testing (if applicable)

- [ ] I have tested my changes locally. Refer to the [Testing
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing)
for more details.
2025-11-26 17:19:48 +00:00
Reece BrowneandGitHub 1e34038b1e various cookie banner fixes (#5027)
# Description of Changes

<!--
Please provide a summary of the changes, including:

- What was changed
- Why the change was made
- Any challenges encountered

Closes #(issue_number)
-->

---

## Checklist

### General

- [ ] I have read the [Contribution
Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
- [ ] I have read the [Stirling-PDF Developer
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md)
(if applicable)
- [ ] I have read the [How to add new languages to
Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md)
(if applicable)
- [ ] I have performed a self-review of my own code
- [ ] My changes generate no new warnings

### Documentation

- [ ] I have updated relevant docs on [Stirling-PDF's doc
repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/)
(if functionality has heavily changed)
- [ ] I have read the section [Add New Translation
Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags)
(for new translation tags only)

### Translations (if applicable)

- [ ] I ran
[`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md)

### UI Changes (if applicable)

- [ ] Screenshots or videos demonstrating the UI changes are attached
(e.g., as comments or direct attachments in the PR)

### Testing (if applicable)

- [ ] I have tested my changes locally. Refer to the [Testing
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing)
for more details.
2025-11-26 15:57:04 +00:00
Anthony StirlingandGitHub d4765938a8 publish GHAs (#5026)
# Description of Changes

<!--
Please provide a summary of the changes, including:

- What was changed
- Why the change was made
- Any challenges encountered

Closes #(issue_number)
-->

---

## Checklist

### General

- [ ] I have read the [Contribution
Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md)
- [ ] I have read the [Stirling-PDF Developer
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md)
(if applicable)
- [ ] I have read the [How to add new languages to
Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md)
(if applicable)
- [ ] I have performed a self-review of my own code
- [ ] My changes generate no new warnings

### Documentation

- [ ] I have updated relevant docs on [Stirling-PDF's doc
repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/)
(if functionality has heavily changed)
- [ ] I have read the section [Add New Translation
Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags)
(for new translation tags only)

### Translations (if applicable)

- [ ] I ran
[`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md)

### UI Changes (if applicable)

- [ ] Screenshots or videos demonstrating the UI changes are attached
(e.g., as comments or direct attachments in the PR)

### Testing (if applicable)

- [ ] I have tested my changes locally. Refer to the [Testing
Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing)
for more details.
2025-11-26 15:22:02 +00:00
Anthony StirlingandGitHub 476e1505ee Merge pull request #4826 from Stirling-Tools/V2-translations
Recreate translation files
2025-11-26 15:04:15 +00:00
James Brunton d3491ecccf Remove JSON translation files 2025-11-26 14:13:54 +00:00
James Brunton cddd5e7d15 Convert V2 translations to Toml 2025-11-26 14:13:54 +00:00
James Brunton f4c9becce2 Move translation files to V2 2025-11-26 14:06:52 +00:00
James BruntonandGitHub 7629d89356 Fix login loop on self-hosted desktop (#5022)
# Description of Changes
Fix #5017 

Changes the handling of jwt tokens to be stored in local storage as well
as OS keyring so the rest of the app knows that you're logged in.
2025-11-26 13:51:12 +00:00
ConnorYohandGitHub 9fdb5295cb Added posthog variables directly to code (#5024) 2025-11-26 12:32:02 +00:00
237 changed files with 249709 additions and 325404 deletions
+504 -247
View File
@@ -1,4 +1,4 @@
name: Test Installers Build
name: Multi-OS Tauri Releases
on:
workflow_dispatch:
@@ -6,7 +6,23 @@ on:
test_mode:
description: "Run in test mode (skip release step)"
required: false
default: "false"
default: "true"
type: choice
options:
- "true"
- "false"
platform:
description: "Platform to build (windows, macos, linux, or all)"
required: true
default: "all"
type: choice
options:
- all
- windows
- macos
- linux
push:
branches: [main, V2, V2-demo, V2-master]
release:
types: [created]
@@ -14,288 +30,500 @@ permissions:
contents: read
jobs:
read_versions:
determine-matrix:
runs-on: ubuntu-latest
outputs:
matrix: ${{ steps.set-matrix.outputs.matrix }}
version: ${{ steps.versionNumber.outputs.versionNumber }}
versionMac: ${{ steps.versionNumberMac.outputs.versionNumberMac }}
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Set up JDK
uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0
- name: Set up JDK 21
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
with:
distribution: 'temurin'
java-version: '21'
java-version: "21"
distribution: "temurin"
- uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0
with:
gradle-version: 8.14
# ✅ Get version from Gradle
- name: Get version number
id: versionNumber
run: |
echo "Running gradlew printVersion..."
./gradlew printVersion --quiet
VERSION=$(./gradlew printVersion --quiet | tail -1)
echo "Extracted version: $VERSION"
echo "versionNumber=$VERSION" >> $GITHUB_OUTPUT
# ✅ Get Mac-specific version from Gradle
- name: Get version number mac
id: versionNumberMac
- name: Determine build matrix
id: set-matrix
run: |
VERSION_MAC=$(./gradlew printMacVersion --quiet | tail -1)
echo "versionNumberMac=$VERSION_MAC" >> $GITHUB_OUTPUT
build-portable:
needs: read_versions
runs-on: ubuntu-latest
strategy:
matrix:
disable_security: [true, false]
include:
- disable_security: false
file_suffix: "-with-login"
- disable_security: true
file_suffix: ""
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up JDK 21
uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0
with:
java-version: "21"
distribution: "temurin"
- uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0
with:
gradle-version: 8.14
- name: Generate jar (Disable Security=${{ matrix.disable_security }})
run: ./gradlew clean createExe
env:
DISABLE_ADDITIONAL_FEATURES: ${{ matrix.disable_security }}
STIRLING_PDF_DESKTOP_UI: false
- name: Rename binaries
run: |
mkdir ./binaries
mv ./build/launch4j/Stirling-PDF.exe ./binaries/win-Stirling-PDF-portable-Server${{ matrix.file_suffix }}.exe
mv ./app/core/build/libs/stirling-pdf-${{ needs.read_versions.outputs.version }}.jar ./binaries/Stirling-PDF${{ matrix.file_suffix }}.jar
- name: Upload build artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
retention-days: 1
if-no-files-found: error
name: stirling${{ matrix.file_suffix }}-binaries
path: |
./binaries/*
sign_verify-portable:
needs: [build-portable, read_versions]
runs-on: ubuntu-latest
strategy:
matrix:
disable_security: [true, false]
include:
- disable_security: false
file_suffix: "with-login-"
- disable_security: true
file_suffix: ""
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- name: Download build artifacts
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
name: stirling-${{ matrix.file_suffix }}binaries
- name: Display structure of downloaded files
run: ls -R
- name: Upload signed artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
retention-days: 1
if-no-files-found: error
name: stirling-${{ matrix.file_suffix }}signed
path: |
./*
!cosign.*
build-installers:
needs: read_versions
strategy:
matrix:
include:
- os: windows-latest
platform: win-
- os: macos-latest
platform: mac-
# - os: ubuntu-latest
# platform: linux-
runs-on: ${{ matrix.os }}
permissions:
contents: write
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up JDK 21
uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0
with:
java-version: "21"
distribution: "temurin"
- uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0
with:
gradle-version: 8.14
# Install Windows dependencies
- name: Install WiX Toolset
if: matrix.os == 'windows-latest'
run: |
curl -L -o wix.exe https://github.com/wixtoolset/wix3/releases/download/wix3141rtm/wix314.exe
.\wix.exe /install /quiet
# Build installer
- name: Build Installer
run: ./gradlew build jpackage -x test --info
env:
DISABLE_ADDITIONAL_FEATURES: true
STIRLING_PDF_DESKTOP_UI: true
BROWSER_OPEN: true
- name: Set up JDK (x86_64)
if: matrix.os == 'macos-latest'
run: |
curl -L -o jdk.tar.gz https://cdn.azul.com/zulu/bin/zulu17.56.15-ca-jdk17.0.14-macosx_x64.tar.gz
mkdir -p zulu17
tar -xzf jdk.tar.gz -C zulu17 --strip-components=1
echo "JAVA_HOME=$PWD/zulu17" >> $GITHUB_ENV
echo "$PWD/zulu17/bin" >> $GITHUB_PATH
- name: Verify JDK architecture
if: matrix.os == 'macos-latest'
run: file $JAVA_HOME/bin/java
- name: Build project and run jpackage (x86_64)
if: matrix.os == 'macos-latest'
run: arch -x86_64 ./gradlew jpackageMacX64
# Rename and collect artifacts based on OS
- name: Prepare artifacts
id: prepare
shell: bash
run: |
ls -lah ./build/jpackage/
mkdir ./binaries
if [ "${{ matrix.os }}" = "windows-latest" ]; then
mv "./build/jpackage/Stirling PDF-${{ needs.read_versions.outputs.version }}.exe" "./binaries/Stirling-PDF-win-installer.exe"
elif [ "${{ matrix.os }}" = "macos-latest" ]; then
mv "./build/jpackage/Stirling PDF-${{ needs.read_versions.outputs.versionMac }}.dmg" "./binaries/Stirling-PDF-mac-installer.dmg"
mv "./build/jpackage/x86_64/Stirling PDF (x86_64)-${{ needs.read_versions.outputs.versionMac }}.dmg" "./binaries/Stirling-PDF-mac-x86_64-installer.dmg"
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
case "${{ github.event.inputs.platform }}" in
"windows")
echo 'matrix={"include":[{"platform":"windows-latest","args":"--target x86_64-pc-windows-msvc","name":"windows-x86_64"}]}' >> $GITHUB_OUTPUT
;;
"macos")
echo 'matrix={"include":[{"platform":"macos-15","args":"--target aarch64-apple-darwin","name":"macos-aarch64"},{"platform":"macos-15-intel","args":"--target x86_64-apple-darwin","name":"macos-x86_64"}]}' >> $GITHUB_OUTPUT
;;
"linux")
echo 'matrix={"include":[{"platform":"ubuntu-22.04","args":"","name":"linux-x86_64"}]}' >> $GITHUB_OUTPUT
;;
*)
echo 'matrix={"include":[{"platform":"windows-latest","args":"--target x86_64-pc-windows-msvc","name":"windows-x86_64"},{"platform":"macos-15","args":"--target aarch64-apple-darwin","name":"macos-aarch64"},{"platform":"macos-15-intel","args":"--target x86_64-apple-darwin","name":"macos-x86_64"},{"platform":"ubuntu-22.04","args":"","name":"linux-x86_64"}]}' >> $GITHUB_OUTPUT
;;
esac
else
mv "./build/jpackage/stirling-pdf_${{ needs.read_versions.outputs.version }}-1_amd64.deb" "./binaries/Stirling-PDF-linux-installer.deb"
# For push/release events, build all platforms
echo 'matrix={"include":[{"platform":"windows-latest","args":"--target x86_64-pc-windows-msvc","name":"windows-x86_64"},{"platform":"macos-15","args":"--target aarch64-apple-darwin","name":"macos-aarch64"},{"platform":"macos-15-intel","args":"--target x86_64-apple-darwin","name":"macos-x86_64"},{"platform":"ubuntu-22.04","args":"","name":"linux-x86_64"}]}' >> $GITHUB_OUTPUT
fi
- name: Display structure of downloaded files
run: ls -R ./binaries
- name: Upload build artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
retention-days: 1
if-no-files-found: error
name: ${{ matrix.platform }}binaries
path: |
./binaries/*
sign_verify:
needs: [read_versions, build-installers]
build-jars:
needs: determine-matrix
runs-on: ubuntu-latest
strategy:
matrix:
include:
- os: windows-latest
platform: win-
- os: macos-latest
platform: mac-
# - os: ubuntu-latest
# platform: linux-
runs-on: ubuntu-latest
variant:
- name: "default"
disable_security: true
build_frontend: true
file_suffix: ""
- name: "with-login"
disable_security: false
build_frontend: true
file_suffix: "-with-login"
- name: "server-only"
disable_security: true
build_frontend: false
file_suffix: "-server"
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- name: Download build artifacts
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Set up JDK 21
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
with:
name: ${{ matrix.platform }}binaries
java-version: "21"
distribution: "temurin"
- name: Display structure of downloaded files
run: ls -R
- uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0
with:
gradle-version: 8.14
- name: Install Cosign
if: matrix.os == 'windows-latest'
uses: sigstore/cosign-installer@d7543c93d881b35a8faa02e8e3605f69b7a1ce62 # v3.10.0
- name: Setup Node.js
if: matrix.variant.build_frontend == true
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
cache-dependency-path: frontend/package-lock.json
- name: Generate key pair
if: matrix.os == 'windows-latest'
run: cosign generate-key-pair
- name: Build JAR
run: ./gradlew clean build ${{ matrix.variant.build_frontend && '-PbuildWithFrontend=true' || '' }} -x spotlessApply -x spotlessCheck -x test -x sonarqube
env:
DISABLE_ADDITIONAL_FEATURES: ${{ matrix.variant.disable_security }}
STIRLING_PDF_DESKTOP_UI: false
- name: Sign and generate attestations
if: matrix.os == 'windows-latest'
- name: Rename JAR
run: |
cosign sign-blob \
--key ./cosign.key \
--yes \
--output-signature ./Stirling-PDF-win-installer.exe.sig \
./Stirling-PDF-win-installer.exe
echo "Version from determine-matrix: ${{ needs.determine-matrix.outputs.version }}"
echo "Looking for: app/core/build/libs/stirling-pdf-${{ needs.determine-matrix.outputs.version }}.jar"
ls -la app/core/build/libs/
mkdir -p ./jar-dist
cp app/core/build/libs/stirling-pdf-${{ needs.determine-matrix.outputs.version }}.jar ./jar-dist/Stirling-PDF${{ matrix.variant.file_suffix }}.jar
cosign attest-blob \
--predicate - \
--key ./cosign.key \
--yes \
--output-attestation ./Stirling-PDF-win-installer.exe.intoto.jsonl \
./Stirling-PDF-win-installer.exe
cosign verify-blob \
--key ./cosign.pub \
--signature ./Stirling-PDF-win-installer.exe.sig \
./Stirling-PDF-win-installer.exe
- name: Display structure of downloaded files
run: ls -R
- name: Upload signed artifacts
- name: Upload JAR artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: jar${{ matrix.variant.file_suffix }}
path: ./jar-dist/*.jar
retention-days: 1
build:
needs: determine-matrix
strategy:
fail-fast: false
matrix: ${{ fromJson(needs.determine-matrix.outputs.matrix) }}
runs-on: ${{ matrix.platform }}
env:
SM_API_KEY: ${{ secrets.SM_API_KEY }}
WINDOWS_CERTIFICATE: ${{ secrets.WINDOWS_CERTIFICATE }}
steps:
- name: Harden Runner
uses: step-security/harden-runner@002fdce3c6a235733a90a27c80493a3241e56863 # v2.12.1
with:
egress-policy: audit
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies (ubuntu only)
if: matrix.platform == 'ubuntu-22.04'
run: |
sudo apt-get update
sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf libjavascriptcoregtk-4.0-dev libsoup2.4-dev libjavascriptcoregtk-4.1-dev libsoup-3.0-dev
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
cache-dependency-path: frontend/package-lock.json
- name: Setup Rust
uses: dtolnay/rust-toolchain@stable
with:
toolchain: stable
targets: ${{ (matrix.platform == 'macos-15' || matrix.platform == 'macos-15-intel') && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }}
- name: Set up JDK 21
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
with:
java-version: "21"
distribution: "temurin"
- name: Build Java backend with JLink
working-directory: ./
shell: bash
run: |
chmod +x ./gradlew
echo "🔧 Building Stirling-PDF JAR..."
./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube
# Find the built JAR
STIRLING_JAR=$(ls app/core/build/libs/stirling-pdf-*.jar | head -n 1)
echo "✅ Built JAR: $STIRLING_JAR"
# Create Tauri directories
mkdir -p ./frontend/src-tauri/libs
mkdir -p ./frontend/src-tauri/runtime
# Copy JAR to Tauri libs
cp "$STIRLING_JAR" ./frontend/src-tauri/libs/
echo "✅ JAR copied to Tauri libs"
# Analyze JAR dependencies for jlink modules
echo "🔍 Analyzing JAR dependencies..."
if command -v jdeps &> /dev/null; then
DETECTED_MODULES=$(jdeps --print-module-deps --ignore-missing-deps "$STIRLING_JAR" 2>/dev/null || echo "")
if [ -n "$DETECTED_MODULES" ]; then
echo "📋 jdeps detected modules: $DETECTED_MODULES"
MODULES="$DETECTED_MODULES,java.compiler,java.instrument,java.management,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.security.jgss,java.security.sasl,java.sql,java.transaction.xa,java.xml.crypto,jdk.crypto.ec,jdk.crypto.cryptoki,jdk.unsupported"
else
echo "⚠️ jdeps analysis failed, using predefined modules"
MODULES="java.base,java.compiler,java.desktop,java.instrument,java.logging,java.management,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.security.jgss,java.security.sasl,java.sql,java.transaction.xa,java.xml,java.xml.crypto,jdk.crypto.ec,jdk.crypto.cryptoki,jdk.unsupported"
fi
else
echo "⚠️ jdeps not available, using predefined modules"
MODULES="java.base,java.compiler,java.desktop,java.instrument,java.logging,java.management,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.security.jgss,java.security.sasl,java.sql,java.transaction.xa,java.xml,java.xml.crypto,jdk.crypto.ec,jdk.crypto.cryptoki,jdk.unsupported"
fi
# Create custom JRE with jlink
echo "🔧 Creating custom JRE with jlink..."
echo "📋 Using modules: $MODULES"
# Remove any existing JRE
rm -rf ./frontend/src-tauri/runtime/jre
# Create the custom JRE
jlink \
--add-modules "$MODULES" \
--strip-debug \
--compress=2 \
--no-header-files \
--no-man-pages \
--output ./frontend/src-tauri/runtime/jre
if [ ! -d "./frontend/src-tauri/runtime/jre" ]; then
echo "❌ Failed to create JLink runtime"
exit 1
fi
# Test the bundled runtime
if [ -f "./frontend/src-tauri/runtime/jre/bin/java" ]; then
RUNTIME_VERSION=$(./frontend/src-tauri/runtime/jre/bin/java --version 2>&1 | head -n 1)
echo "✅ Custom JRE created successfully: $RUNTIME_VERSION"
else
echo "❌ Custom JRE executable not found"
exit 1
fi
# Calculate runtime size
RUNTIME_SIZE=$(du -sh ./frontend/src-tauri/runtime/jre | cut -f1)
echo "📊 Custom JRE size: $RUNTIME_SIZE"
env:
DISABLE_ADDITIONAL_FEATURES: true
- name: Install frontend dependencies
working-directory: ./frontend
run: npm install
# DigiCert KeyLocker Setup (Cloud HSM)
- name: Setup DigiCert KeyLocker
id: digicert-setup
if: ${{ matrix.platform == 'windows-latest' && env.SM_API_KEY != '' && (github.event_name == 'release' || github.ref == 'refs/heads/V2-master') }}
uses: digicert/ssm-code-signing@v1.1.0
env:
SM_API_KEY: ${{ secrets.SM_API_KEY }}
SM_CLIENT_CERT_FILE_B64: ${{ secrets.SM_CLIENT_CERT_FILE_B64 }}
SM_CLIENT_CERT_PASSWORD: ${{ secrets.SM_CLIENT_CERT_PASSWORD }}
SM_KEYPAIR_ALIAS: ${{ secrets.SM_KEYPAIR_ALIAS }}
SM_HOST: ${{ secrets.SM_HOST }}
- name: Setup DigiCert KeyLocker Certificate
if: ${{ matrix.platform == 'windows-latest' && env.SM_API_KEY != '' && (github.event_name == 'release' || github.ref == 'refs/heads/V2-master') }}
shell: pwsh
run: |
Write-Host "Setting up DigiCert KeyLocker environment..."
# Decode client certificate
$certBytes = [Convert]::FromBase64String("${{ secrets.SM_CLIENT_CERT_FILE_B64 }}")
$certPath = "D:\Certificate_pkcs12.p12"
[IO.File]::WriteAllBytes($certPath, $certBytes)
# Set environment variables
echo "SM_CLIENT_CERT_FILE=D:\Certificate_pkcs12.p12" >> $env:GITHUB_ENV
echo "SM_HOST=${{ secrets.SM_HOST }}" >> $env:GITHUB_ENV
echo "SM_API_KEY=${{ secrets.SM_API_KEY }}" >> $env:GITHUB_ENV
echo "SM_CLIENT_CERT_PASSWORD=${{ secrets.SM_CLIENT_CERT_PASSWORD }}" >> $env:GITHUB_ENV
echo "SM_KEYPAIR_ALIAS=${{ secrets.SM_KEYPAIR_ALIAS }}" >> $env:GITHUB_ENV
# Get PKCS11 config path from DigiCert action
$pkcs11Config = $env:PKCS11_CONFIG
if ($pkcs11Config) {
Write-Host "Found PKCS11_CONFIG: $pkcs11Config"
echo "PKCS11_CONFIG=$pkcs11Config" >> $env:GITHUB_ENV
} else {
Write-Host "PKCS11_CONFIG not set by DigiCert action, using default path"
$defaultPath = "C:\Users\RUNNER~1\AppData\Local\Temp\smtools-windows-x64\pkcs11properties.cfg"
if (Test-Path $defaultPath) {
Write-Host "Found config at default path: $defaultPath"
echo "PKCS11_CONFIG=$defaultPath" >> $env:GITHUB_ENV
} else {
Write-Host "Warning: Could not find PKCS11 config file"
}
}
# Traditional PFX Certificate Import (fallback if KeyLocker not configured)
- name: Import Windows Code Signing Certificate
if: ${{ matrix.platform == 'windows-latest' && env.SM_API_KEY == '' && (github.event_name == 'release' || github.ref == 'refs/heads/V2-master') }}
env:
WINDOWS_CERTIFICATE: ${{ secrets.WINDOWS_CERTIFICATE }}
WINDOWS_CERTIFICATE_PASSWORD: ${{ secrets.WINDOWS_CERTIFICATE_PASSWORD }}
shell: powershell
run: |
if ($env:WINDOWS_CERTIFICATE) {
Write-Host "Importing Windows Code Signing Certificate..."
# Decode base64 certificate and save to file
$certBytes = [Convert]::FromBase64String($env:WINDOWS_CERTIFICATE)
$certPath = Join-Path $env:RUNNER_TEMP "certificate.pfx"
[IO.File]::WriteAllBytes($certPath, $certBytes)
# Import certificate to CurrentUser\My store
$cert = Import-PfxCertificate -FilePath $certPath -CertStoreLocation Cert:\CurrentUser\My -Password (ConvertTo-SecureString -String $env:WINDOWS_CERTIFICATE_PASSWORD -AsPlainText -Force)
# Extract and set thumbprint as environment variable
$thumbprint = $cert.Thumbprint
Write-Host "Certificate imported with thumbprint: $thumbprint"
echo "WINDOWS_CERTIFICATE_THUMBPRINT=$thumbprint" >> $env:GITHUB_ENV
# Clean up certificate file
Remove-Item $certPath
Write-Host "Windows certificate import completed."
} else {
Write-Host "⚠️ WINDOWS_CERTIFICATE secret not set - building unsigned binary"
}
- name: Import Apple Developer Certificate
if: (matrix.platform == 'macos-15' || matrix.platform == 'macos-15-intel') && (github.event_name == 'release' || github.ref == 'refs/heads/V2-master')
env:
APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
run: |
echo "Importing Apple Developer Certificate..."
echo $APPLE_CERTIFICATE | base64 --decode > certificate.p12
# Create temporary keychain
KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db
KEYCHAIN_PASSWORD=$(openssl rand -base64 32)
security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
# Import certificate
security import certificate.p12 -P "$APPLE_CERTIFICATE_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
security list-keychain -d user -s $KEYCHAIN_PATH
security set-key-partition-list -S apple-tool:,apple: -k "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
# Clean up
rm certificate.p12
- name: Verify Certificate
if: (matrix.platform == 'macos-15' || matrix.platform == 'macos-15-intel') && (github.event_name == 'release' || github.ref == 'refs/heads/V2-master')
run: |
echo "Verifying Apple Developer Certificate..."
KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db
CERT_INFO=$(security find-identity -v -p codesigning $KEYCHAIN_PATH | grep "Developer ID Application")
echo "Certificate Info: $CERT_INFO"
CERT_ID=$(echo "$CERT_INFO" | awk -F'"' '{print $2}')
echo "Certificate ID: $CERT_ID"
echo "APPLE_SIGNING_IDENTITY=$CERT_ID" >> $GITHUB_ENV
echo "Certificate imported successfully."
- name: Build Tauri app
uses: tauri-apps/tauri-action@v0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
APPLE_SIGNING_IDENTITY: ${{ env.APPLE_SIGNING_IDENTITY }}
APPLE_ID: ${{ secrets.APPLE_ID }}
APPLE_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD }}
APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
APPIMAGETOOL_SIGN_PASSPHRASE: ${{ secrets.APPIMAGETOOL_SIGN_PASSPHRASE }}
TAURI_SIGNING_PRIVATE_KEY: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY }}
TAURI_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY_PASSWORD }}
VITE_SUPABASE_PUBLISHABLE_DEFAULT_KEY: ${{ secrets.VITE_SUPABASE_PUBLISHABLE_DEFAULT_KEY }}
VITE_SAAS_SERVER_URL: ${{ secrets.VITE_SAAS_SERVER_URL }}
# Only enable Windows signing in Tauri when on release or V2-master
SIGN: ${{ (github.event_name == 'release' || github.ref == 'refs/heads/V2-master') && (env.SM_API_KEY == '' && env.WINDOWS_CERTIFICATE != '') && '1' || '0' }}
CI: true
with:
projectPath: ./frontend
tauriScript: npx tauri
args: ${{ matrix.args }}
# Sign with DigiCert KeyLocker (post-build)
- name: Sign Windows binaries with DigiCert KeyLocker
if: ${{ matrix.platform == 'windows-latest' && env.SM_API_KEY != '' && (github.event_name == 'release' || github.ref == 'refs/heads/V2-master') }}
shell: pwsh
run: |
Write-Host "=== DigiCert KeyLocker Signing ==="
# Test smctl connectivity first
Write-Host "Testing smctl connection..."
$healthCheck = & smctl healthcheck 2>&1
if ($LASTEXITCODE -eq 0) {
Write-Host "[SUCCESS] Connected to DigiCert KeyLocker"
} else {
Write-Host "[ERROR] Failed to connect to DigiCert KeyLocker"
Write-Host $healthCheck
exit 1
}
Write-Host ""
# Sync certificates to Windows certificate store
Write-Host "Syncing certificates to Windows certificate store..."
$syncOutput = & smctl windows certsync 2>&1
Write-Host "Cert sync result: $syncOutput"
Write-Host ""
# Find only the files we need to sign
$filesToSign = @()
# Main application executable
$mainExe = Get-ChildItem -Path "./frontend/src-tauri/target/x86_64-pc-windows-msvc/release" -Filter "stirling-pdf.exe" -File -ErrorAction SilentlyContinue
if ($mainExe) { $filesToSign += $mainExe }
# MSI installer
$msiFiles = Get-ChildItem -Path "./frontend/src-tauri/target" -Filter "*.msi" -Recurse -File
$filesToSign += $msiFiles
if ($filesToSign.Count -eq 0) {
Write-Host "[ERROR] No files found to sign"
exit 1
}
Write-Host "Found $($filesToSign.Count) files to sign:"
foreach ($f in $filesToSign) { Write-Host " - $($f.Name)" }
Write-Host ""
$signedCount = 0
foreach ($file in $filesToSign) {
Write-Host "Signing: $($file.Name)"
# Get PKCS11 config file path
$pkcs11Config = $env:PKCS11_CONFIG
if (-not $pkcs11Config) {
Write-Host "[ERROR] PKCS11_CONFIG environment variable not set"
exit 1
}
Write-Host "Using PKCS11 config: $pkcs11Config"
# Try signing with certificate fingerprint first (if available)
$fingerprint = "${{ secrets.SM_CODE_SIGNING_CERT_SHA1_HASH }}"
if ($fingerprint -and $fingerprint -ne "") {
Write-Host "Attempting to sign with certificate fingerprint..."
$output = & smctl sign --fingerprint "$fingerprint" --input "$($file.FullName)" --config-file "$pkcs11Config" --verbose 2>&1
$exitCode = $LASTEXITCODE
} else {
Write-Host "No fingerprint provided, using keypair alias..."
$output = & smctl sign --keypair-alias "${{ secrets.SM_KEYPAIR_ALIAS }}" --input "$($file.FullName)" --config-file "$pkcs11Config" --verbose 2>&1
$exitCode = $LASTEXITCODE
}
Write-Host "Exit code: $exitCode"
Write-Host "Output: $output"
if ($output -match "FAILED" -or $output -match "error" -or $output -match "Error") {
Write-Host "[ERROR] Signing failed for $($file.Name)"
exit 1
}
if ($exitCode -ne 0) {
Write-Host "[ERROR] Failed to sign $($file.Name)"
Write-Host "Full error output:"
Write-Host $output
exit 1
}
$signedCount++
Write-Host "[SUCCESS] Signed: $($file.Name)"
Write-Host ""
}
Write-Host "=== Summary ==="
Write-Host "[SUCCESS] Signed $signedCount/$($filesToSign.Count) files successfully"
- name: Rename artifacts
shell: bash
run: |
mkdir -p ./dist
cd ./frontend/src-tauri/target
# Find and rename artifacts based on platform
if [ "${{ matrix.platform }}" = "windows-latest" ]; then
find . -name "*.exe" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.exe" \;
find . -name "*.msi" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.msi" \;
elif [ "${{ matrix.platform }}" = "macos-15" ] || [ "${{ matrix.platform }}" = "macos-15-intel" ]; then
find . -name "*.dmg" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.dmg" \;
find . -name "*.app" -exec cp -r {} "../../../dist/Stirling-PDF-${{ matrix.name }}.app" \;
else
find . -name "*.deb" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.deb" \;
find . -name "*.AppImage" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.AppImage" \;
fi
- name: Upload build artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: Stirling-PDF-${{ matrix.name }}
path: ./dist/*
retention-days: 1
if-no-files-found: error
name: ${{ matrix.platform }}signed
path: |
./Stirling-PDF-${{ matrix.platform }}installer.*
./Stirling-PDF-${{ matrix.platform }}x86_64-installer.*
!cosign.*
create-release:
if: github.event_name != 'workflow_dispatch' || github.event.inputs.test_mode != 'true'
needs: [read_versions, sign_verify, sign_verify-portable]
if: (github.event_name == 'workflow_dispatch' && github.event.inputs.test_mode != 'true') || github.event_name == 'release' || github.ref == 'refs/heads/V2-master'
needs: [determine-matrix, build, build-jars]
runs-on: ubuntu-latest
permissions:
contents: write
@@ -305,14 +533,43 @@ jobs:
with:
egress-policy: audit
- name: Download signed artifacts
- name: Download all Tauri artifacts
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
pattern: Stirling-PDF-*
path: ./artifacts/tauri
- name: Download JAR artifact (default)
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
name: jar
path: ./artifacts/jars
- name: Download JAR artifact (with login)
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
name: jar-with-login
path: ./artifacts/jars
- name: Download JAR artifact (server only)
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
name: jar-server
path: ./artifacts/jars
- name: Display structure of downloaded files
run: ls -R
- name: Upload binaries, attestations and signatures to Release and create GitHub Release
run: ls -R ./artifacts
- name: Upload binaries to Release
uses: softprops/action-gh-release@62c96d0c4e8a889135c1f3a25910db8dbe0e85f7 # v2.3.4
with:
tag_name: v${{ needs.read_versions.outputs.version }}
tag_name: v${{ needs.determine-matrix.outputs.version }}
generate_release_notes: true
files: |
./*signed/*
./artifacts/**/*.jar
./artifacts/**/*.msi
./artifacts/**/*.dmg
./artifacts/**/*.deb
./artifacts/**/*.AppImage
draft: false
prerelease: false
+244
View File
@@ -0,0 +1,244 @@
name: Push Docker Image - V2 Branch
on:
workflow_dispatch:
push:
branches:
- V2-master
# cancel in-progress jobs if a new job is triggered
# This is useful to avoid running multiple builds for the same branch if a new commit is pushed
# or a pull request is updated.
# It helps to save resources and time by ensuring that only the latest commit is built and tested
# This is particularly useful for long-running jobs that may take a while to complete.
# The `group` is set to a combination of the workflow name, event name, and branch name.
# This ensures that jobs are grouped by the workflow and branch, allowing for cancellation of
# in-progress jobs when a new commit is pushed to the same branch or a new pull request is opened.
concurrency:
group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.ref_name || github.ref }}
cancel-in-progress: true
permissions:
contents: read
jobs:
push:
runs-on: ubuntu-24.04-8core
permissions:
packages: write
id-token: write
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up JDK 21
uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0
with:
java-version: "21"
distribution: "temurin"
- uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0
with:
gradle-version: 8.14
- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
- name: Get version number
id: versionNumber
run: echo "versionNumber=$(./gradlew printVersion --quiet | tail -1)" >> $GITHUB_OUTPUT
- name: Install cosign
if: github.ref == 'refs/heads/V2-master'
uses: sigstore/cosign-installer@d7543c93d881b35a8faa02e8e3605f69b7a1ce62 # v3.10.0
with:
cosign-release: "v2.4.1"
- name: Login to Docker Hub
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
with:
username: ${{ secrets.DOCKER_HUB_USERNAME }}
password: ${{ secrets.DOCKER_HUB_API }}
- name: Login to GitHub Container Registry
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ github.token }}
- name: Set up QEMU
uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3.6.0
- name: Convert repository owner to lowercase
id: repoowner
run: echo "lowercase=$(echo ${{ github.repository_owner }} | awk '{print tolower($0)}')" >> $GITHUB_OUTPUT
- name: Generate tags for latest (V2-master branch - production)
id: meta
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
if: github.ref == 'refs/heads/V2-master'
with:
images: |
${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
ghcr.io/${{ steps.repoowner.outputs.lowercase }}/stirling-pdf
${{ secrets.DOCKER_HUB_ORG_USERNAME }}/stirling-pdf
tags: |
type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}
type=raw,value=latest
- name: Generate tags for latest (V2-demo branch - test)
id: meta-test
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
if: github.ref == 'refs/heads/V2-demo'
with:
images: |
ghcr.io/stirling-tools/stirling-pdf-test
tags: |
type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}
type=raw,value=latest
- name: Build and push Unified Dockerfile (latest variant)
id: build-push-latest
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
with:
builder: ${{ steps.buildx.outputs.name }}
context: .
file: ./docker/Dockerfile.unified
push: true
cache-from: type=gha
cache-to: type=gha,mode=max
tags: ${{ github.ref == 'refs/heads/V2-master' && steps.meta.outputs.tags || steps.meta-test.outputs.tags }}
labels: ${{ github.ref == 'refs/heads/V2-master' && steps.meta.outputs.labels || steps.meta-test.outputs.labels }}
build-args: VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
platforms: linux/amd64,linux/arm64/v8
provenance: true
sbom: true
- name: Sign regular images
if: github.ref == 'refs/heads/V2-master'
env:
DIGEST: ${{ steps.build-push-latest.outputs.digest }}
TAGS: ${{ steps.meta.outputs.tags }}
COSIGN_PRIVATE_KEY: ${{ secrets.COSIGN_PRIVATE_KEY }}
COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }}
run: |
echo "$TAGS" | tr ',' '\n' | while read -r tag; do
cosign sign --yes \
--key env://COSIGN_PRIVATE_KEY \
"${tag}@${DIGEST}"
done
- name: Generate tags for latest-fat (V2-master branch - production)
id: meta-fat
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
if: github.ref == 'refs/heads/V2-master'
with:
images: |
${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
ghcr.io/${{ steps.repoowner.outputs.lowercase }}/stirling-pdf
${{ secrets.DOCKER_HUB_ORG_USERNAME }}/stirling-pdf
tags: |
type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}-fat
type=raw,value=latest-fat
- name: Generate tags for latest-fat (V2-demo branch - test)
id: meta-fat-test
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
if: github.ref == 'refs/heads/V2-demo'
with:
images: |
ghcr.io/stirling-tools/stirling-pdf-test
tags: |
type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}-fat
type=raw,value=latest-fat
- name: Build and push Unified Dockerfile (fat variant)
id: build-push-fat
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
with:
builder: ${{ steps.buildx.outputs.name }}
context: .
file: ./docker/Dockerfile.unified
push: true
cache-from: type=gha
cache-to: type=gha,mode=max
tags: ${{ github.ref == 'refs/heads/V2-master' && steps.meta-fat.outputs.tags || steps.meta-fat-test.outputs.tags }}
labels: ${{ github.ref == 'refs/heads/V2-master' && steps.meta-fat.outputs.labels || steps.meta-fat-test.outputs.labels }}
build-args: VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
platforms: linux/amd64,linux/arm64/v8
provenance: true
sbom: true
- name: Sign fat images
if: github.ref == 'refs/heads/V2-master'
env:
DIGEST: ${{ steps.build-push-fat.outputs.digest }}
TAGS: ${{ steps.meta-fat.outputs.tags }}
COSIGN_PRIVATE_KEY: ${{ secrets.COSIGN_PRIVATE_KEY }}
COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }}
run: |
echo "$TAGS" | tr ',' '\n' | while read -r tag; do
cosign sign --key env://COSIGN_PRIVATE_KEY --yes "${tag}@${DIGEST}"
done
- name: Generate tags for ultra-lite (V2-master branch - production)
id: meta-lite
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
if: github.ref == 'refs/heads/V2-master'
with:
images: |
${{ secrets.DOCKER_HUB_USERNAME }}/s-pdf
ghcr.io/${{ steps.repoowner.outputs.lowercase }}/s-pdf
ghcr.io/${{ steps.repoowner.outputs.lowercase }}/stirling-pdf
${{ secrets.DOCKER_HUB_ORG_USERNAME }}/stirling-pdf
tags: |
type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}-ultra-lite
type=raw,value=latest-ultra-lite
- name: Generate tags for ultra-lite (V2-demo branch - test)
id: meta-lite-test
uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
if: github.ref == 'refs/heads/V2-demo'
with:
images: |
ghcr.io/stirling-tools/stirling-pdf-test
tags: |
type=raw,value=${{ steps.versionNumber.outputs.versionNumber }}-ultra-lite
type=raw,value=latest-ultra-lite
- name: Build and push Unified Dockerfile (ultra-lite variant)
id: build-push-lite
uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
with:
builder: ${{ steps.buildx.outputs.name }}
context: .
file: ./docker/Dockerfile.unified-lite
push: true
cache-from: type=gha
cache-to: type=gha,mode=max
tags: ${{ github.ref == 'refs/heads/V2-master' && steps.meta-lite.outputs.tags || steps.meta-lite-test.outputs.tags }}
labels: ${{ github.ref == 'refs/heads/V2-master' && steps.meta-lite.outputs.labels || steps.meta-lite-test.outputs.labels }}
build-args: VERSION_TAG=${{ steps.versionNumber.outputs.versionNumber }}
platforms: linux/amd64,linux/arm64/v8
provenance: true
sbom: true
- name: Sign ultra-lite images
if: github.ref == 'refs/heads/V2-master'
env:
DIGEST: ${{ steps.build-push-lite.outputs.digest }}
TAGS: ${{ steps.meta-lite.outputs.tags }}
COSIGN_PRIVATE_KEY: ${{ secrets.COSIGN_PRIVATE_KEY }}
COSIGN_PASSWORD: ${{ secrets.COSIGN_PASSWORD }}
run: |
echo "$TAGS" | tr ',' '\n' | while read -r tag; do
cosign sign --key env://COSIGN_PRIVATE_KEY --yes "${tag}@${DIGEST}"
done
+455 -100
View File
@@ -2,85 +2,445 @@ name: Release Artifacts
on:
workflow_dispatch:
release:
types: [created]
inputs:
platform:
description: "Platform to build (windows, macos, linux, or all)"
required: true
default: "all"
type: choice
options:
- all
- windows
- macos
- linux
push:
branches: [main, V2, V2-demo]
permissions:
contents: read
jobs:
build:
determine-matrix:
runs-on: ubuntu-latest
strategy:
matrix:
disable_security: [true, false]
include:
- disable_security: false
file_suffix: "-with-login"
- disable_security: true
file_suffix: ""
outputs:
matrix: ${{ steps.set-matrix.outputs.matrix }}
version: ${{ steps.versionNumber.outputs.versionNumber }}
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Set up JDK 17
uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0
with:
java-version: "17"
distribution: "temurin"
- uses: gradle/actions/setup-gradle@4d9f0ba0025fe599b4ebab900eb7f3a1d93ef4c2 # v5.0.0
with:
gradle-version: 8.14
- name: Generate jar (Disable Security=${{ matrix.disable_security }})
run: ./gradlew clean createExe
env:
DISABLE_ADDITIONAL_FEATURES: ${{ matrix.disable_security }}
STIRLING_PDF_DESKTOP_UI: false
- name: Get version number
id: versionNumber
run: |
VERSION=$(grep "^version =" build.gradle | awk -F'"' '{print $2}')
echo "versionNumber=$VERSION" >> $GITHUB_OUTPUT
- name: Rename binaries
- name: Determine build matrix
id: set-matrix
run: |
mv ./build/launch4j/Stirling-PDF.exe ./build/launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
mv ./build/libs/Stirling-PDF-${{ steps.versionNumber.outputs.versionNumber }}.jar ./build/libs/Stirling-PDF${{ matrix.file_suffix }}.jar
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
case "${{ github.event.inputs.platform }}" in
"windows")
echo 'matrix={"include":[{"platform":"windows-latest","args":"--target x86_64-pc-windows-msvc","name":"windows-x86_64"}]}' >> $GITHUB_OUTPUT
;;
"macos")
echo 'matrix={"include":[{"platform":"macos-15","args":"--target aarch64-apple-darwin","name":"macos-aarch64"},{"platform":"macos-15-intel","args":"--target x86_64-apple-darwin","name":"macos-x86_64"}]}' >> $GITHUB_OUTPUT
;;
"linux")
echo 'matrix={"include":[{"platform":"ubuntu-22.04","args":"","name":"linux-x86_64"}]}' >> $GITHUB_OUTPUT
;;
*)
echo 'matrix={"include":[{"platform":"windows-latest","args":"--target x86_64-pc-windows-msvc","name":"windows-x86_64"},{"platform":"macos-15","args":"--target aarch64-apple-darwin","name":"macos-aarch64"},{"platform":"macos-15-intel","args":"--target x86_64-apple-darwin","name":"macos-x86_64"},{"platform":"ubuntu-22.04","args":"","name":"linux-x86_64"}]}' >> $GITHUB_OUTPUT
;;
esac
else
# For push events, build all platforms
echo 'matrix={"include":[{"platform":"windows-latest","args":"--target x86_64-pc-windows-msvc","name":"windows-x86_64"},{"platform":"macos-15","args":"--target aarch64-apple-darwin","name":"macos-aarch64"},{"platform":"macos-15-intel","args":"--target x86_64-apple-darwin","name":"macos-x86_64"},{"platform":"ubuntu-22.04","args":"","name":"linux-x86_64"}]}' >> $GITHUB_OUTPUT
fi
- name: Debug build artifacts
build:
needs: determine-matrix
strategy:
fail-fast: false
matrix: ${{ fromJson(needs.determine-matrix.outputs.matrix) }}
runs-on: ${{ matrix.platform }}
env:
SM_API_KEY: ${{ secrets.SM_API_KEY }}
WINDOWS_CERTIFICATE: ${{ secrets.WINDOWS_CERTIFICATE }}
steps:
- name: Harden Runner
uses: step-security/harden-runner@002fdce3c6a235733a90a27c80493a3241e56863 # v2.12.1
with:
egress-policy: audit
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Install dependencies (ubuntu only)
if: matrix.platform == 'ubuntu-22.04'
run: |
echo "Current Directory: $(pwd)"
ls -R ./build/libs
ls -R ./build/launch4j
sudo apt-get update
sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf libjavascriptcoregtk-4.0-dev libsoup2.4-dev libjavascriptcoregtk-4.1-dev libsoup-3.0-dev
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
cache-dependency-path: frontend/package-lock.json
- name: Setup Rust
uses: dtolnay/rust-toolchain@stable
with:
toolchain: stable
targets: ${{ (matrix.platform == 'macos-15' || matrix.platform == 'macos-15-intel') && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }}
- name: Set up JDK 21
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
with:
java-version: "21"
distribution: "temurin"
- name: Build Java backend with JLink
working-directory: ./
shell: bash
run: |
chmod +x ./gradlew
echo "🔧 Building Stirling-PDF JAR..."
./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube
# Find the built JAR
STIRLING_JAR=$(ls app/core/build/libs/stirling-pdf-*.jar | head -n 1)
echo "✅ Built JAR: $STIRLING_JAR"
# Create Tauri directories
mkdir -p ./frontend/src-tauri/libs
mkdir -p ./frontend/src-tauri/runtime
# Copy JAR to Tauri libs
cp "$STIRLING_JAR" ./frontend/src-tauri/libs/
echo "✅ JAR copied to Tauri libs"
# Analyze JAR dependencies for jlink modules
echo "🔍 Analyzing JAR dependencies..."
if command -v jdeps &> /dev/null; then
DETECTED_MODULES=$(jdeps --print-module-deps --ignore-missing-deps "$STIRLING_JAR" 2>/dev/null || echo "")
if [ -n "$DETECTED_MODULES" ]; then
echo "📋 jdeps detected modules: $DETECTED_MODULES"
MODULES="$DETECTED_MODULES,java.compiler,java.instrument,java.management,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.security.jgss,java.security.sasl,java.sql,java.transaction.xa,java.xml.crypto,jdk.crypto.ec,jdk.crypto.cryptoki,jdk.unsupported"
else
echo "⚠️ jdeps analysis failed, using predefined modules"
MODULES="java.base,java.compiler,java.desktop,java.instrument,java.logging,java.management,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.security.jgss,java.security.sasl,java.sql,java.transaction.xa,java.xml,java.xml.crypto,jdk.crypto.ec,jdk.crypto.cryptoki,jdk.unsupported"
fi
else
echo "⚠️ jdeps not available, using predefined modules"
MODULES="java.base,java.compiler,java.desktop,java.instrument,java.logging,java.management,java.naming,java.net.http,java.prefs,java.rmi,java.scripting,java.security.jgss,java.security.sasl,java.sql,java.transaction.xa,java.xml,java.xml.crypto,jdk.crypto.ec,jdk.crypto.cryptoki,jdk.unsupported"
fi
# Create custom JRE with jlink
echo "🔧 Creating custom JRE with jlink..."
echo "📋 Using modules: $MODULES"
# Remove any existing JRE
rm -rf ./frontend/src-tauri/runtime/jre
# Create the custom JRE
jlink \
--add-modules "$MODULES" \
--strip-debug \
--compress=2 \
--no-header-files \
--no-man-pages \
--output ./frontend/src-tauri/runtime/jre
if [ ! -d "./frontend/src-tauri/runtime/jre" ]; then
echo "❌ Failed to create JLink runtime"
exit 1
fi
# Test the bundled runtime
if [ -f "./frontend/src-tauri/runtime/jre/bin/java" ]; then
RUNTIME_VERSION=$(./frontend/src-tauri/runtime/jre/bin/java --version 2>&1 | head -n 1)
echo "✅ Custom JRE created successfully: $RUNTIME_VERSION"
else
echo "❌ Custom JRE executable not found"
exit 1
fi
# Calculate runtime size
RUNTIME_SIZE=$(du -sh ./frontend/src-tauri/runtime/jre | cut -f1)
echo "📊 Custom JRE size: $RUNTIME_SIZE"
env:
DISABLE_ADDITIONAL_FEATURES: true
- name: Install frontend dependencies
working-directory: ./frontend
run: npm install
# DigiCert KeyLocker Setup (Cloud HSM)
- name: Setup DigiCert KeyLocker
id: digicert-setup
if: ${{ matrix.platform == 'windows-latest' && env.SM_API_KEY != '' && github.ref == 'refs/heads/main' }}
uses: digicert/ssm-code-signing@v1.1.0
env:
SM_API_KEY: ${{ secrets.SM_API_KEY }}
SM_CLIENT_CERT_FILE_B64: ${{ secrets.SM_CLIENT_CERT_FILE_B64 }}
SM_CLIENT_CERT_PASSWORD: ${{ secrets.SM_CLIENT_CERT_PASSWORD }}
SM_KEYPAIR_ALIAS: ${{ secrets.SM_KEYPAIR_ALIAS }}
SM_HOST: ${{ secrets.SM_HOST }}
- name: Setup DigiCert KeyLocker Certificate
if: ${{ matrix.platform == 'windows-latest' && env.SM_API_KEY != '' && github.ref == 'refs/heads/main' }}
shell: pwsh
run: |
Write-Host "Setting up DigiCert KeyLocker environment..."
# Decode client certificate
$certBytes = [Convert]::FromBase64String("${{ secrets.SM_CLIENT_CERT_FILE_B64 }}")
$certPath = "D:\Certificate_pkcs12.p12"
[IO.File]::WriteAllBytes($certPath, $certBytes)
# Set environment variables
echo "SM_CLIENT_CERT_FILE=D:\Certificate_pkcs12.p12" >> $env:GITHUB_ENV
echo "SM_HOST=${{ secrets.SM_HOST }}" >> $env:GITHUB_ENV
echo "SM_API_KEY=${{ secrets.SM_API_KEY }}" >> $env:GITHUB_ENV
echo "SM_CLIENT_CERT_PASSWORD=${{ secrets.SM_CLIENT_CERT_PASSWORD }}" >> $env:GITHUB_ENV
echo "SM_KEYPAIR_ALIAS=${{ secrets.SM_KEYPAIR_ALIAS }}" >> $env:GITHUB_ENV
# Get PKCS11 config path from DigiCert action
$pkcs11Config = $env:PKCS11_CONFIG
if ($pkcs11Config) {
Write-Host "Found PKCS11_CONFIG: $pkcs11Config"
echo "PKCS11_CONFIG=$pkcs11Config" >> $env:GITHUB_ENV
} else {
Write-Host "PKCS11_CONFIG not set by DigiCert action, using default path"
$defaultPath = "C:\Users\RUNNER~1\AppData\Local\Temp\smtools-windows-x64\pkcs11properties.cfg"
if (Test-Path $defaultPath) {
Write-Host "Found config at default path: $defaultPath"
echo "PKCS11_CONFIG=$defaultPath" >> $env:GITHUB_ENV
} else {
Write-Host "Warning: Could not find PKCS11 config file"
}
}
# Traditional PFX Certificate Import (fallback if KeyLocker not configured)
- name: Import Windows Code Signing Certificate
if: ${{ matrix.platform == 'windows-latest' && env.SM_API_KEY == '' && github.ref == 'refs/heads/main' }}
env:
WINDOWS_CERTIFICATE: ${{ secrets.WINDOWS_CERTIFICATE }}
WINDOWS_CERTIFICATE_PASSWORD: ${{ secrets.WINDOWS_CERTIFICATE_PASSWORD }}
shell: powershell
run: |
if ($env:WINDOWS_CERTIFICATE) {
Write-Host "Importing Windows Code Signing Certificate..."
# Decode base64 certificate and save to file
$certBytes = [Convert]::FromBase64String($env:WINDOWS_CERTIFICATE)
$certPath = Join-Path $env:RUNNER_TEMP "certificate.pfx"
[IO.File]::WriteAllBytes($certPath, $certBytes)
# Import certificate to CurrentUser\My store
$cert = Import-PfxCertificate -FilePath $certPath -CertStoreLocation Cert:\CurrentUser\My -Password (ConvertTo-SecureString -String $env:WINDOWS_CERTIFICATE_PASSWORD -AsPlainText -Force)
# Extract and set thumbprint as environment variable
$thumbprint = $cert.Thumbprint
Write-Host "Certificate imported with thumbprint: $thumbprint"
echo "WINDOWS_CERTIFICATE_THUMBPRINT=$thumbprint" >> $env:GITHUB_ENV
# Clean up certificate file
Remove-Item $certPath
Write-Host "Windows certificate import completed."
} else {
Write-Host "⚠️ WINDOWS_CERTIFICATE secret not set - building unsigned binary"
}
- name: Import Apple Developer Certificate
if: matrix.platform == 'macos-15' || matrix.platform == 'macos-15-intel'
env:
APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
run: |
echo "Importing Apple Developer Certificate..."
echo $APPLE_CERTIFICATE | base64 --decode > certificate.p12
# Create temporary keychain
KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db
KEYCHAIN_PASSWORD=$(openssl rand -base64 32)
security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
# Import certificate
security import certificate.p12 -P "$APPLE_CERTIFICATE_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
security list-keychain -d user -s $KEYCHAIN_PATH
security set-key-partition-list -S apple-tool:,apple: -k "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
# Clean up
rm certificate.p12
- name: Verify Certificate
if: matrix.platform == 'macos-15' || matrix.platform == 'macos-15-intel'
run: |
echo "Verifying Apple Developer Certificate..."
KEYCHAIN_PATH=$RUNNER_TEMP/app-signing.keychain-db
CERT_INFO=$(security find-identity -v -p codesigning $KEYCHAIN_PATH | grep "Developer ID Application")
echo "Certificate Info: $CERT_INFO"
CERT_ID=$(echo "$CERT_INFO" | awk -F'"' '{print $2}')
echo "Certificate ID: $CERT_ID"
echo "APPLE_SIGNING_IDENTITY=$CERT_ID" >> $GITHUB_ENV
echo "Certificate imported successfully."
- name: Build Tauri app
uses: tauri-apps/tauri-action@v0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
APPLE_SIGNING_IDENTITY: ${{ env.APPLE_SIGNING_IDENTITY }}
APPLE_ID: ${{ secrets.APPLE_ID }}
APPLE_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD }}
APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
APPIMAGETOOL_SIGN_PASSPHRASE: ${{ secrets.APPIMAGETOOL_SIGN_PASSPHRASE }}
TAURI_SIGNING_PRIVATE_KEY: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY }}
TAURI_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY_PASSWORD }}
VITE_SUPABASE_PUBLISHABLE_DEFAULT_KEY: ${{ secrets.VITE_SUPABASE_PUBLISHABLE_DEFAULT_KEY }}
VITE_SAAS_SERVER_URL: ${{ secrets.VITE_SAAS_SERVER_URL }}
# Only enable Windows signing in Tauri when on main
SIGN: ${{ github.ref == 'refs/heads/main' && (env.SM_API_KEY == '' && env.WINDOWS_CERTIFICATE != '') && '1' || '0' }}
CI: true
with:
projectPath: ./frontend
tauriScript: npx tauri
args: ${{ matrix.args }}
# Sign with DigiCert KeyLocker (post-build)
- name: Sign Windows binaries with DigiCert KeyLocker
if: ${{ matrix.platform == 'windows-latest' && env.SM_API_KEY != '' && github.ref == 'refs/heads/main' }}
shell: pwsh
run: |
Write-Host "=== DigiCert KeyLocker Signing ==="
# Test smctl connectivity first
Write-Host "Testing smctl connection..."
$healthCheck = & smctl healthcheck 2>&1
if ($LASTEXITCODE -eq 0) {
Write-Host "[SUCCESS] Connected to DigiCert KeyLocker"
} else {
Write-Host "[ERROR] Failed to connect to DigiCert KeyLocker"
Write-Host $healthCheck
exit 1
}
Write-Host ""
# Sync certificates to Windows certificate store
Write-Host "Syncing certificates to Windows certificate store..."
$syncOutput = & smctl windows certsync 2>&1
Write-Host "Cert sync result: $syncOutput"
Write-Host ""
# Find only the files we need to sign (not build scripts)
$filesToSign = @()
# Main application executable
$mainExe = Get-ChildItem -Path "./frontend/src-tauri/target/x86_64-pc-windows-msvc/release" -Filter "stirling-pdf.exe" -File -ErrorAction SilentlyContinue
if ($mainExe) { $filesToSign += $mainExe }
# MSI installer
$msiFiles = Get-ChildItem -Path "./frontend/src-tauri/target" -Filter "*.msi" -Recurse -File
$filesToSign += $msiFiles
if ($filesToSign.Count -eq 0) {
Write-Host "[ERROR] No files found to sign"
exit 1
}
Write-Host "Found $($filesToSign.Count) files to sign:"
foreach ($f in $filesToSign) { Write-Host " - $($f.Name)" }
Write-Host ""
$signedCount = 0
foreach ($file in $filesToSign) {
Write-Host "Signing: $($file.Name)"
# Get PKCS11 config file path (set by DigiCert action)
$pkcs11Config = $env:PKCS11_CONFIG
if (-not $pkcs11Config) {
Write-Host "[ERROR] PKCS11_CONFIG environment variable not set"
Write-Host "DigiCert KeyLocker action may not have run correctly"
exit 1
}
Write-Host "Using PKCS11 config: $pkcs11Config"
# Try signing with certificate fingerprint first (if available)
$fingerprint = "${{ secrets.SM_CODE_SIGNING_CERT_SHA1_HASH }}"
if ($fingerprint -and $fingerprint -ne "") {
Write-Host "Attempting to sign with certificate fingerprint..."
$output = & smctl sign --fingerprint "$fingerprint" --input "$($file.FullName)" --config-file "$pkcs11Config" --verbose 2>&1
$exitCode = $LASTEXITCODE
} else {
Write-Host "No fingerprint provided, using keypair alias..."
# Use smctl to sign with keypair alias
$output = & smctl sign --keypair-alias "${{ secrets.SM_KEYPAIR_ALIAS }}" --input "$($file.FullName)" --config-file "$pkcs11Config" --verbose 2>&1
$exitCode = $LASTEXITCODE
}
Write-Host "Exit code: $exitCode"
Write-Host "Output: $output"
# Check if output contains "FAILED" even with exit code 0
if ($output -match "FAILED" -or $output -match "error" -or $output -match "Error") {
Write-Host ""
Write-Host "[ERROR] Signing failed for $($file.Name)"
Write-Host "[ERROR] smctl returned success but output indicates failure"
exit 1
}
if ($exitCode -ne 0) {
Write-Host "[ERROR] Failed to sign $($file.Name)"
Write-Host "Full error output:"
Write-Host $output
exit 1
}
$signedCount++
Write-Host "[SUCCESS] Signed: $($file.Name)"
Write-Host ""
}
Write-Host "=== Summary ==="
Write-Host "[SUCCESS] Signed $signedCount/$($filesToSign.Count) files successfully"
- name: Rename artifacts
shell: bash
run: |
mkdir -p ./dist
cd ./frontend/src-tauri/target
# Find and rename artifacts based on platform
if [ "${{ matrix.platform }}" = "windows-latest" ]; then
find . -name "*.exe" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.exe" \;
find . -name "*.msi" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.msi" \;
elif [ "${{ matrix.platform }}" = "macos-15" ] || [ "${{ matrix.platform }}" = "macos-15-intel" ]; then
find . -name "*.dmg" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.dmg" \;
find . -name "*.app" -exec cp -r {} "../../../dist/Stirling-PDF-${{ matrix.name }}.app" \;
else
find . -name "*.deb" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.deb" \;
find . -name "*.AppImage" -exec cp {} "../../../dist/Stirling-PDF-${{ matrix.name }}.AppImage" \;
fi
- name: Upload build artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: binaries${{ matrix.file_suffix }}
path: |
./build/launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.*
./build/libs/Stirling-PDF${{ matrix.file_suffix }}.*
name: Stirling-PDF-${{ matrix.name }}
path: ./dist/*
retention-days: 30
sign_verify:
needs: build
runs-on: ubuntu-latest
if: success()
strategy:
fail-fast: false
matrix:
disable_security: [true, false]
include:
- disable_security: false
file_suffix: "-with-login"
- disable_security: true
file_suffix: ""
name: [windows-x86_64, macos-aarch64, macos-x86_64, linux-x86_64]
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
@@ -90,7 +450,8 @@ jobs:
- name: Download build artifacts
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
name: binaries${{ matrix.file_suffix }}
name: Stirling-PDF-${{ matrix.name }}
- name: Display structure of downloaded files
run: ls -R
@@ -101,80 +462,74 @@ jobs:
run: cosign generate-key-pair
- name: Sign and generate attestations
shell: bash
run: |
cosign sign-blob \
--key ./cosign.key \
--yes \
--output-signature ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar.sig \
./libs/Stirling-PDF${{ matrix.file_suffix }}.jar
# Sign all artifacts for this platform
for file in *; do
if [ -f "$file" ] && [[ ! "$file" =~ \.(sig|intoto\.jsonl)$ ]]; then
echo "Signing: $file"
cosign attest-blob \
--predicate - \
--key ./cosign.key \
--yes \
--output-attestation ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar.intoto.jsonl \
./libs/Stirling-PDF${{ matrix.file_suffix }}.jar
# Sign the artifact
cosign sign-blob \
--key ./cosign.key \
--yes \
--output-signature "${file}.sig" \
"$file"
cosign verify-blob \
--key ./cosign.pub \
--signature ./libs/Stirling-PDF${{ matrix.file_suffix }}.jar.sig \
./libs/Stirling-PDF${{ matrix.file_suffix }}.jar
# Generate attestation
cosign attest-blob \
--predicate - \
--key ./cosign.key \
--yes \
--output-attestation "${file}.intoto.jsonl" \
"$file"
cosign sign-blob \
--key ./cosign.key \
--yes \
--output-signature ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe.sig \
./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
# Verify the signature
cosign verify-blob \
--key ./cosign.pub \
--signature "${file}.sig" \
"$file"
cosign attest-blob \
--predicate - \
--key ./cosign.key \
--yes \
--output-attestation ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe.intoto.jsonl \
./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
cosign verify-blob \
--key ./cosign.pub \
--signature ./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe.sig \
./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.exe
echo "✅ Signed and verified: $file"
fi
done
- name: Upload signed artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: signed${{ matrix.file_suffix }}
name: Stirling-PDF-${{ matrix.name }}-signed
path: |
./libs/Stirling-PDF${{ matrix.file_suffix }}.*
./launch4j/Stirling-PDF-Server${{ matrix.file_suffix }}.*
*
!cosign.key
!cosign.pub
retention-days: 30
release:
needs: [build, sign_verify]
needs: [determine-matrix, build, sign_verify]
runs-on: ubuntu-latest
if: github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main'
permissions:
contents: write
strategy:
matrix:
disable_security: [true, false]
include:
- disable_security: false
file_suffix: "-with-login"
- disable_security: true
file_suffix: ""
steps:
- name: Harden Runner
uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
with:
egress-policy: audit
- name: Download signed artifacts
- name: Download all signed artifacts
uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
with:
name: signed${{ matrix.file_suffix }}
pattern: Stirling-PDF-*-signed
path: ./artifacts
- name: Upload binaries, attestations and signatures to Release and create GitHub Release
- name: Display structure of downloaded files
run: ls -R ./artifacts
- name: Create GitHub Release
uses: softprops/action-gh-release@62c96d0c4e8a889135c1f3a25910db8dbe0e85f7 # v2.3.4
with:
tag_name: v${{ needs.build.outputs.version }}
tag_name: v${{ needs.determine-matrix.outputs.version }}
generate_release_notes: true
files: |
./libs/Stirling-PDF*
./launch4j/Stirling-PDF-Server*
files: ./artifacts/**/*
draft: false
prerelease: false
+16 -2
View File
@@ -17,8 +17,8 @@ local.properties
version.properties
#### Stirling-PDF Files ###
pipeline/watchedFolders/
pipeline/finishedFolders/
pipeline/
!pipeline/.gitkeep
customFiles/
configs/
watchedFolders/
@@ -31,6 +31,20 @@ exampleYmlFiles/stirling/
/testing/file_snapshots
SwaggerDoc.json
# Frontend build artifacts copied to backend static resources
# These are generated by npm build and should not be committed
app/core/src/main/resources/static/assets/
app/core/src/main/resources/static/index.html
app/core/src/main/resources/static/locales/
app/core/src/main/resources/static/Login/
app/core/src/main/resources/static/classic-logo/
app/core/src/main/resources/static/modern-logo/
app/core/src/main/resources/static/og_images/
app/core/src/main/resources/static/samples/
app/core/src/main/resources/static/manifest-classic.json
app/core/src/main/resources/static/robots.txt
# Note: Keep backend-managed files like fonts/, css/, js/, pdfjs/, etc.
# Gradle
.gradle
.gradle-home
+4
View File
@@ -6,6 +6,10 @@ Portions of this software are licensed as follows:
* All content that resides under the "app/proprietary/" directory of this repository,
if that directory exists, is licensed under the license defined in "app/proprietary/LICENSE".
* All content that resides under the "frontend/src/proprietary/" directory of this repository,
if that directory exists, is licensed under the license defined in "frontend/src/proprietary/LICENSE".
* All content that resides under the "frontend/src/desktop/" directory of this repository,
if that directory exists, is licensed under the license defined in "frontend/src/desktop/LICENSE".
* Content outside of the above mentioned directories or restrictions above is
available under the MIT License as defined below.
+3 -3
View File
@@ -33,16 +33,16 @@ dependencies {
api 'com.googlecode.owasp-java-html-sanitizer:owasp-java-html-sanitizer:20240325.1'
api 'com.fathzer:javaluator:3.0.6'
api 'com.posthog.java:posthog:1.2.0'
api 'org.apache.commons:commons-lang3:3.19.0'
api 'org.apache.commons:commons-lang3:3.17.0'
api 'com.drewnoakes:metadata-extractor:2.19.0' // Image metadata extractor
api 'com.vladsch.flexmark:flexmark-html2md-converter:0.64.8'
api "org.apache.pdfbox:pdfbox:$pdfboxVersion"
api "org.apache.pdfbox:xmpbox:$pdfboxVersion"
api "org.apache.pdfbox:preflight:$pdfboxVersion"
api 'com.github.junrar:junrar:7.5.5' // RAR archive support for CBR files
api 'com.github.junrar:junrar:7.5.7' // RAR archive support for CBR files
api 'jakarta.servlet:jakarta.servlet-api:6.1.0'
api 'org.snakeyaml:snakeyaml-engine:2.10'
api "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.13"
api "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.14"
api 'jakarta.mail:jakarta.mail-api:2.1.5'
runtimeOnly 'org.eclipse.angus:angus-mail:2.0.5'
}
@@ -0,0 +1,14 @@
package stirling.software.common.model.api.security;
import java.util.List;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class AddParticipantsRequest {
private List<Long> participantUserIds;
}
@@ -0,0 +1,48 @@
package stirling.software.common.model.api.security;
import java.util.List;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import stirling.software.common.model.api.PDFFile;
@Data
@EqualsAndHashCode(callSuper = true)
public class CreateSigningSessionRequest extends PDFFile {
@Schema(description = "Owner email used for activity updates")
private String ownerEmail;
@Schema(
description = "User IDs of participants to invite for signing",
requiredMode = Schema.RequiredMode.REQUIRED)
private List<Long> participantUserIds;
@Schema(description = "Optional message included in notifications")
private String message;
@Schema(description = "Optional due date for reminders (ISO-8601 date)")
private String dueDate;
@Schema(description = "Whether to send notifications immediately")
private Boolean notifyOnCreate;
// Signature appearance settings (owner-controlled, applied to all participants)
@Schema(description = "Whether to show visible signature")
private Boolean showSignature;
@Schema(description = "Page number for signature (1-indexed)")
private Integer pageNumber;
@Schema(description = "Signature reason")
private String reason;
@Schema(description = "Signature location")
private String location;
@Schema(description = "Whether to show Stirling PDF logo in signature")
private Boolean showLogo;
}
@@ -0,0 +1,17 @@
package stirling.software.common.model.api.security;
import java.util.List;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Data
public class NotifySigningParticipantsRequest {
@Schema(description = "Participants to notify; defaults to all if omitted")
private List<String> participantEmails;
@Schema(description = "Notification message to deliver")
private String message;
}
@@ -0,0 +1,50 @@
package stirling.software.common.model.api.security;
import org.springframework.web.multipart.MultipartFile;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
@Data
public class ParticipantCertificateRequest {
@Schema(
description = "Certificate type for the participant",
allowableValues = {"PEM", "PKCS12", "PFX", "JKS", "SERVER"},
requiredMode = Schema.RequiredMode.REQUIRED)
private String certType;
@Schema(description = "Password for keystore or private key", format = "password")
private String password;
@Schema(description = "Private key for PEM flow")
private MultipartFile privateKeyFile;
@Schema(description = "Certificate for PEM flow")
private MultipartFile certFile;
@Schema(description = "PKCS12/PFX keystore")
private MultipartFile p12File;
@Schema(description = "JKS keystore")
private MultipartFile jksFile;
@Schema(description = "Display the signature visually")
private Boolean showSignature;
@Schema(description = "Page number for visible signature (1-indexed)")
private Integer pageNumber;
@Schema(description = "Custom signer name override")
private String name;
@Schema(description = "Signing reason")
private String reason;
@Schema(description = "Signing location")
private String location;
@Schema(description = "Show the Stirling PDF logo in the appearance")
private Boolean showLogo;
}
@@ -0,0 +1,21 @@
package stirling.software.common.model.api.security;
import lombok.Builder;
import lombok.Data;
@Data
@Builder
public class ParticipantCertificateSubmission {
private String certType;
private String password;
private byte[] privateKey;
private byte[] certificate;
private byte[] p12Keystore;
private byte[] jksKeystore;
private Boolean showSignature;
private Integer pageNumber;
private String name;
private String reason;
private String location;
private Boolean showLogo;
}
@@ -0,0 +1,25 @@
package stirling.software.common.model.api.security;
import java.time.LocalDateTime;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class ParticipantDTO {
private Long userId;
private String username;
private String displayName;
private ParticipantStatus status;
private LocalDateTime lastUpdated;
// Signature appearance settings (owner-controlled)
private Boolean showSignature;
private Integer pageNumber;
private String reason;
private String location;
private Boolean showLogo;
}
@@ -0,0 +1,9 @@
package stirling.software.common.model.api.security;
public enum ParticipantStatus {
PENDING,
NOTIFIED,
VIEWED,
SIGNED,
DECLINED
}
@@ -0,0 +1,81 @@
package stirling.software.common.model.api.security;
import org.springframework.web.multipart.MultipartFile;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Pattern;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
* Request object for signing a document. Combines certificate submission data with optional wet
* signature (visual signature) metadata.
*/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class SignDocumentRequest {
// Certificate-related fields
@NotNull(message = "Certificate type is required")
@Pattern(
regexp = "SERVER|USER_CERT|UPLOAD|PEM|PKCS12|PFX|JKS",
message = "Invalid certificate type")
private String certType;
private MultipartFile p12File;
private String password;
private MultipartFile privateKeyFile;
private MultipartFile certFile;
// Wet signature metadata fields (optional)
private String wetSignatureType; // "canvas" | "image" | "text"
private String wetSignatureData; // Base64 image data or text
private Integer wetSignaturePage; // Zero-indexed page number
private Double wetSignatureX; // X coordinate in PDF points
private Double wetSignatureY; // Y coordinate in PDF points (top-left origin)
private Double wetSignatureWidth; // Width in PDF points
private Double wetSignatureHeight; // Height in PDF points
/**
* Checks if this request includes wet signature metadata.
*
* @return true if wet signature data is present
*/
public boolean hasWetSignature() {
return wetSignatureType != null
&& wetSignatureData != null
&& wetSignaturePage != null
&& wetSignatureX != null
&& wetSignatureY != null
&& wetSignatureWidth != null
&& wetSignatureHeight != null;
}
/**
* Extracts wet signature metadata into a dedicated DTO.
*
* @return WetSignatureMetadata object if wet signature is present, null otherwise
*/
public WetSignatureMetadata extractWetSignatureMetadata() {
if (!hasWetSignature()) {
return null;
}
WetSignatureMetadata metadata = new WetSignatureMetadata();
metadata.setType(wetSignatureType);
metadata.setData(wetSignatureData);
metadata.setPage(wetSignaturePage);
metadata.setX(wetSignatureX);
metadata.setY(wetSignatureY);
metadata.setWidth(wetSignatureWidth);
metadata.setHeight(wetSignatureHeight);
// Validate the metadata
metadata.validate();
return metadata;
}
}
@@ -0,0 +1,25 @@
package stirling.software.common.model.api.security;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/** DTO for sign request detail (participant view) */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class SignRequestDetailDTO {
private String sessionId;
private String documentName;
private String ownerUsername;
private String message;
private String dueDate;
private String createdAt;
private ParticipantStatus myStatus;
// Signature appearance settings (read-only, configured by owner)
private Boolean showSignature;
private Integer pageNumber;
private String reason;
private String location;
private Boolean showLogo;
}
@@ -0,0 +1,18 @@
package stirling.software.common.model.api.security;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/** DTO for sign request summary (participant view) */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class SignRequestSummaryDTO {
private String sessionId;
private String documentName;
private String ownerUsername;
private String createdAt;
private String dueDate;
private ParticipantStatus myStatus;
}
@@ -0,0 +1,26 @@
package stirling.software.common.model.api.security;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import lombok.Data;
@Data
public class SigningParticipant {
private Long userId; // Database user ID (null for in-memory sessions)
private String email;
private String name;
private ParticipantStatus status = ParticipantStatus.PENDING;
private List<String> notifications = new ArrayList<>();
private String shareToken = UUID.randomUUID().toString();
private String lastUpdated = Instant.now().toString();
private ParticipantCertificateSubmission certificateSubmission;
public void recordNotification(String message) {
notifications.add(message);
lastUpdated = Instant.now().toString();
}
}
@@ -0,0 +1,26 @@
package stirling.software.common.model.api.security;
import java.time.Instant;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import lombok.Data;
@Data
public class SigningSession {
private String sessionId = UUID.randomUUID().toString();
private String documentName;
private byte[] originalPdf;
private byte[] signedPdf;
private String ownerEmail;
private String message;
private String dueDate;
private String createdAt = Instant.now().toString();
private String updatedAt = Instant.now().toString();
private List<SigningParticipant> participants = new ArrayList<>();
public void touch() {
updatedAt = Instant.now().toString();
}
}
@@ -0,0 +1,23 @@
package stirling.software.common.model.api.security;
import java.time.LocalDateTime;
import java.util.List;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class SigningSessionDetailDTO {
private String sessionId;
private String documentName;
private String ownerEmail;
private String message;
private String dueDate;
private LocalDateTime createdAt;
private LocalDateTime updatedAt;
private boolean finalized;
private List<ParticipantDTO> participants;
}
@@ -0,0 +1,19 @@
package stirling.software.common.model.api.security;
import java.time.LocalDateTime;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class SigningSessionSummaryDTO {
private String sessionId;
private String documentName;
private LocalDateTime createdAt;
private int participantCount;
private int signedCount;
private boolean finalized;
}
@@ -0,0 +1,16 @@
package stirling.software.common.model.api.security;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserSummaryDTO {
private Long userId;
private String username;
private String displayName;
private String teamName;
private boolean enabled;
}
@@ -0,0 +1,96 @@
package stirling.software.common.model.api.security;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Pattern;
import jakarta.validation.constraints.Positive;
import jakarta.validation.constraints.PositiveOrZero;
import jakarta.validation.constraints.Size;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
* Data Transfer Object for wet signature (visual signature) metadata. Contains information about a
* signature annotation placed by a participant on the PDF. This data is used to overlay the
* signature on the PDF during finalization.
*/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class WetSignatureMetadata {
/** Type of wet signature: "canvas" (drawn), "image" (uploaded), or "text" (typed) */
@NotNull(message = "Wet signature type is required")
@Pattern(
regexp = "canvas|image|text",
message = "Wet signature type must be canvas, image, or text")
private String type;
/**
* Base64-encoded image data or text content for the signature. For canvas/image types:
* data:image/png;base64,... format For text type: plain text string
*/
@NotNull(message = "Wet signature data is required")
@Size(max = 5_000_000, message = "Wet signature data exceeds maximum size of 5MB")
private String data;
/** Zero-indexed page number where the signature is placed */
@NotNull(message = "Page number is required")
@PositiveOrZero(message = "Page number must be zero or positive")
private Integer page;
/** X coordinate (in PDF points) of the signature rectangle, measured from left edge */
@NotNull(message = "X coordinate is required")
@PositiveOrZero(message = "X coordinate must be zero or positive")
private Double x;
/**
* Y coordinate (in PDF points) of the signature rectangle, measured from top edge. Note: This
* is UI coordinate system (top-left origin). Will be converted to PDF coordinate system
* (bottom-left origin) during overlay.
*/
@NotNull(message = "Y coordinate is required")
@PositiveOrZero(message = "Y coordinate must be zero or positive")
private Double y;
/** Width of the signature rectangle in PDF points */
@NotNull(message = "Width is required")
@Positive(message = "Width must be positive")
private Double width;
/** Height of the signature rectangle in PDF points */
@NotNull(message = "Height is required")
@Positive(message = "Height must be positive")
private Double height;
/**
* Validates that the wet signature data is properly formatted based on type. For image types,
* ensures data starts with data:image prefix.
*
* @return true if validation passes
* @throws IllegalArgumentException if validation fails
*/
public boolean validate() {
if (type.equals("canvas") || type.equals("image")) {
if (!data.startsWith("data:image/")) {
throw new IllegalArgumentException(
"Image wet signature data must start with data:image/ prefix");
}
}
return true;
}
/**
* Extracts just the base64 data portion from a data URL. Removes the "data:image/png;base64,"
* prefix.
*
* @return pure base64 string without data URL prefix
*/
public String extractBase64Data() {
if (data != null && data.contains(",")) {
return data.substring(data.indexOf(",") + 1);
}
return data;
}
}
@@ -0,0 +1,155 @@
package stirling.software.common.service;
import java.io.IOException;
import java.util.List;
public interface SigningSessionServiceInterface {
/**
* Creates a new signing session
*
* @param request The session creation request
* @param username The username of the session owner (optional, pass null for non-authenticated)
* @return The created session (implementation-specific return type)
*/
Object createSession(Object request, String username) throws IOException;
/**
* Gets a signing session by ID
*
* @param sessionId The session ID
* @return The session object (implementation-specific return type)
*/
Object getSession(String sessionId);
/**
* Lists all sessions for a user
*
* @param username The username
* @return List of session summaries (implementation-specific return type)
*/
List<?> listUserSessions(String username);
/**
* Gets detailed session information with ownership validation
*
* @param sessionId The session ID
* @param username The username for ownership validation
* @return Detailed session object (implementation-specific return type)
*/
Object getSessionDetail(String sessionId, String username);
/**
* Deletes a session
*
* @param sessionId The session ID
* @param username The username for ownership validation
*/
void deleteSession(String sessionId, String username);
/**
* Adds participants to a session
*
* @param sessionId The session ID
* @param request The request containing participant emails and names
* @param username The username for ownership validation
* @return Updated session detail (implementation-specific return type)
*/
Object addParticipants(String sessionId, Object request, String username);
/**
* Removes a participant from a session
*
* @param sessionId The session ID
* @param userId The participant's user ID
* @param username The username for ownership validation
*/
void removeParticipant(String sessionId, Long userId, String username);
/**
* Notifies participants
*
* @param sessionId The session ID
* @param request The notification request
* @return The updated session (implementation-specific return type)
*/
Object notifyParticipants(String sessionId, Object request);
/**
* Attaches a certificate for a participant
*
* @param sessionId The session ID
* @param userId The participant's user ID
* @param request The certificate request
* @return The updated session (implementation-specific return type)
*/
Object attachCertificate(String sessionId, Long userId, Object request) throws IOException;
/**
* Marks a session as finalized
*
* @param sessionId The session ID
* @param signedPdf The final signed PDF bytes
*/
void markSessionFinalized(String sessionId, byte[] signedPdf);
/**
* Gets the PDF for a session with user authentication
*
* @param sessionId The session ID
* @param username The participant's username
* @return The PDF bytes
*/
byte[] getSessionPdf(String sessionId, String username);
/**
* Gets the signed PDF from a finalized session with ownership validation
*
* @param sessionId The session ID
* @param username The username for ownership validation
* @return The signed PDF bytes, or null if not finalized
*/
byte[] getSignedPdf(String sessionId, String username);
/**
* Lists sign requests for a participant
*
* @param username The participant's username
* @return List of sign requests where user is a participant
*/
List<?> listSignRequests(String username);
/**
* Gets sign request detail for a participant
*
* @param sessionId The session ID
* @param username The participant's username
* @return Sign request detail DTO (implementation-specific return type)
*/
Object getSignRequestDetail(String sessionId, String username);
/**
* Declines a sign request
*
* @param sessionId The session ID
* @param username The participant's username
*/
void declineSignRequest(String sessionId, String username);
/**
* Signs a document with optional wet signature metadata
*
* @param sessionId The session ID
* @param username The participant's username
* @param request The sign document request containing certificate and wet signature data
* @throws IOException if certificate processing fails
*/
void signDocument(String sessionId, String username, Object request) throws IOException;
/**
* Checks if this is the database-backed implementation
*
* @return true if database-backed, false if in-memory
*/
boolean isDatabaseBacked();
}
@@ -7,23 +7,103 @@ public class RequestUriUtils {
}
public static boolean isStaticResource(String contextPath, String requestURI) {
return requestURI.startsWith(contextPath + "/css/")
|| requestURI.startsWith(contextPath + "/fonts/")
|| requestURI.startsWith(contextPath + "/js/")
|| requestURI.endsWith(contextPath + "robots.txt")
|| requestURI.startsWith(contextPath + "/images/")
|| requestURI.startsWith(contextPath + "/public/")
|| requestURI.startsWith(contextPath + "/pdfjs/")
|| requestURI.startsWith(contextPath + "/pdfjs-legacy/")
|| requestURI.startsWith(contextPath + "/login")
|| requestURI.startsWith(contextPath + "/error")
|| requestURI.startsWith(contextPath + "/favicon")
|| requestURI.endsWith(".svg")
|| requestURI.endsWith(".png")
|| requestURI.endsWith(".ico")
|| requestURI.endsWith(".txt")
|| requestURI.endsWith(".webmanifest")
|| requestURI.startsWith(contextPath + "/api/v1/info/status");
if (requestURI == null) {
return false;
}
String normalizedUri = stripContextPath(contextPath, requestURI);
// API routes are never static except for the public status endpoint
if (normalizedUri.startsWith("/api/")) {
return normalizedUri.startsWith("/api/v1/info/status");
}
// Well-known static asset directories (backend + React build artifacts)
if (normalizedUri.startsWith("/css/")
|| normalizedUri.startsWith("/fonts/")
|| normalizedUri.startsWith("/js/")
|| normalizedUri.startsWith("/images/")
|| normalizedUri.startsWith("/public/")
|| normalizedUri.startsWith("/pdfjs/")
|| normalizedUri.startsWith("/pdfjs-legacy/")
|| normalizedUri.startsWith("/assets/")
|| normalizedUri.startsWith("/locales/")
|| normalizedUri.startsWith("/Login/")
|| normalizedUri.startsWith("/samples/")
|| normalizedUri.startsWith("/classic-logo/")
|| normalizedUri.startsWith("/modern-logo/")
|| normalizedUri.startsWith("/og_images/")) {
return true;
}
// Specific static files bundled with the frontend
if (normalizedUri.equals("/robots.txt")
|| normalizedUri.equals("/favicon.ico")
|| normalizedUri.equals("/site.webmanifest")
|| normalizedUri.equals("/manifest-classic.json")
|| normalizedUri.equals("/index.html")) {
return true;
}
// Login/error pages remain public
if (normalizedUri.startsWith("/login") || normalizedUri.startsWith("/error")) {
return true;
}
// Treat common static file extensions as static resources
return normalizedUri.endsWith(".svg")
|| normalizedUri.endsWith(".png")
|| normalizedUri.endsWith(".ico")
|| normalizedUri.endsWith(".txt")
|| normalizedUri.endsWith(".webmanifest")
|| normalizedUri.endsWith(".js")
|| normalizedUri.endsWith(".css")
|| normalizedUri.endsWith(".mjs")
|| normalizedUri.endsWith(".html")
|| normalizedUri.endsWith(".toml");
}
public static boolean isFrontendRoute(String contextPath, String requestURI) {
if (requestURI == null) {
return false;
}
String normalizedUri = stripContextPath(contextPath, requestURI);
// APIs are never treated as frontend routes
if (normalizedUri.startsWith("/api/")) {
return false;
}
// Blocklist of backend/non-frontend paths that should still go through filters
String[] backendOnlyPrefixes = {
"/register",
"/invite",
"/pipeline",
"/pdfjs",
"/pdfjs-legacy",
"/fonts",
"/images",
"/files",
"/css",
"/js",
"/swagger",
"/v1/api-docs",
"/actuator"
};
for (String prefix : backendOnlyPrefixes) {
if (normalizedUri.equals(prefix) || normalizedUri.startsWith(prefix + "/")) {
return false;
}
}
if (normalizedUri.isBlank()) {
return false;
}
// Allow root and any extensionless path (React Router will handle these)
return !normalizedUri.contains(".");
}
public static boolean isTrackableResource(String requestURI) {
@@ -43,6 +123,7 @@ public class RequestUriUtils {
|| requestURI.endsWith(".svg")
|| requestURI.endsWith("popularity.txt")
|| requestURI.endsWith(".js")
|| requestURI.endsWith(".toml")
|| requestURI.contains("swagger")
|| requestURI.startsWith("/api/v1/info")
|| requestURI.startsWith("/site.webmanifest")
@@ -83,4 +164,11 @@ public class RequestUriUtils {
|| trimmedUri.startsWith("/api/v1/invite/accept")
|| trimmedUri.contains("/v1/api-docs");
}
private static String stripContextPath(String contextPath, String requestURI) {
if (contextPath != null && !contextPath.isBlank() && requestURI.startsWith(contextPath)) {
return requestURI.substring(contextPath.length());
}
return requestURI;
}
}
@@ -49,6 +49,27 @@ public class RequestUriUtilsTest {
"API products should not be static");
}
@Test
void testIsFrontendRoute() {
assertTrue(
RequestUriUtils.isFrontendRoute("", "/"), "Root path should be a frontend route");
assertTrue(
RequestUriUtils.isFrontendRoute("", "/app/dashboard"),
"React routes without extensions should be frontend routes");
assertFalse(
RequestUriUtils.isFrontendRoute("", "/api/v1/users"),
"API routes should not be frontend routes");
assertFalse(
RequestUriUtils.isFrontendRoute("", "/register"),
"Register should not be treated as a frontend route");
assertFalse(
RequestUriUtils.isFrontendRoute("", "/pipeline/jobs"),
"Pipeline should not be treated as a frontend route");
assertFalse(
RequestUriUtils.isFrontendRoute("", "/files/download"),
"Files path should not be treated as a frontend route");
}
@Test
void testIsStaticResourceWithContextPath() {
String contextPath = "/myapp";
@@ -83,6 +104,7 @@ public class RequestUriUtilsTest {
"/favicon.ico",
"/icon.svg",
"/image.png",
"/locales/en/translation.toml",
"/site.webmanifest",
"/app/logo.svg",
"/downloads/document.png",
+125
View File
@@ -1,5 +1,7 @@
apply plugin: 'org.springframework.boot'
import org.apache.tools.ant.taskdefs.condition.Os
repositories {
maven { url = 'https://build.shibboleth.net/maven/releases' }
maven { url = 'https://maven.pkg.github.com/jcefmaven/jcefmaven' }
@@ -15,6 +17,7 @@ configurations {
spotless {
java {
target 'src/**/java/**/*.java'
targetExclude 'src/main/resources/static/**'
googleJavaFormat(googleJavaFormatVersion).aosp().reorderImports(false)
importOrder("java", "javax", "org", "com", "net", "io", "jakarta", "lombok", "me", "stirling")
@@ -25,12 +28,14 @@ spotless {
}
yaml {
target '**/*.yml', '**/*.yaml'
targetExclude 'src/main/resources/static/**'
trimTrailingWhitespace()
leadingTabsToSpaces()
endWithNewline()
}
format 'gradle', {
target '**/gradle/*.gradle', '**/*.gradle'
targetExclude 'src/main/resources/static/**'
trimTrailingWhitespace()
leadingTabsToSpaces()
endWithNewline()
@@ -157,5 +162,125 @@ springBoot {
mainClass = 'stirling.software.SPDF.SPDFApplication'
}
// Frontend build tasks - only enabled with -PbuildWithFrontend=true
def buildWithFrontend = project.hasProperty('buildWithFrontend') && project.property('buildWithFrontend') == 'true'
def frontendDir = file('../../frontend')
def frontendDistDir = file('../../frontend/dist')
def resourcesStaticDir = file('src/main/resources/static')
def generatedFrontendPaths = [
'assets',
'index.html',
'locales',
'Login',
'classic-logo',
'modern-logo',
'og_images',
'samples',
'manifest-classic.json'
]
tasks.register('npmInstall', Exec) {
enabled = buildWithFrontend
group = 'frontend'
description = 'Install frontend dependencies'
workingDir frontendDir
commandLine = Os.isFamily(Os.FAMILY_WINDOWS) ? ['cmd', '/c', 'npm', 'ci', '--prefer-offline'] : ['npm', 'ci', '--prefer-offline']
inputs.file(new File(frontendDir, 'package.json'))
inputs.file(new File(frontendDir, 'package-lock.json'))
outputs.dir(new File(frontendDir, 'node_modules'))
// Show live output
standardOutput = System.out
errorOutput = System.err
// Skip if node_modules exists and is up-to-date
onlyIf {
def nodeModules = new File(frontendDir, 'node_modules')
if (!nodeModules.exists()) {
println "node_modules not found, will install..."
return true
}
def packageJson = new File(frontendDir, 'package.json')
def packageLock = new File(frontendDir, 'package-lock.json')
def isOutdated = nodeModules.lastModified() < packageJson.lastModified() ||
nodeModules.lastModified() < packageLock.lastModified()
if (isOutdated) {
println "package.json or package-lock.json changed, will reinstall..."
} else {
println "node_modules is up-to-date, skipping npm install"
}
return isOutdated
}
doFirst {
println "Installing npm dependencies in ${frontendDir}..."
}
}
tasks.register('npmBuild', Exec) {
enabled = buildWithFrontend
group = 'frontend'
description = 'Build frontend application'
workingDir frontendDir
commandLine = Os.isFamily(Os.FAMILY_WINDOWS) ? ['cmd', '/c', 'npm', 'run', 'build'] : ['npm', 'run', 'build']
dependsOn npmInstall
inputs.dir(new File(frontendDir, 'src'))
inputs.file(new File(frontendDir, 'package.json'))
outputs.dir(frontendDistDir)
// Show live output
standardOutput = System.out
errorOutput = System.err
// Override VITE_API_BASE_URL to use relative paths for production builds
// This ensures JARs work regardless of how they're deployed (direct, proxied, etc.)
environment 'VITE_API_BASE_URL', '/'
doFirst {
println "Building frontend application for production (VITE_API_BASE_URL=/)"
}
}
tasks.register('copyFrontendAssets', Copy) {
enabled = buildWithFrontend
group = 'frontend'
description = 'Copy frontend build to static resources'
dependsOn npmBuild
from(frontendDistDir) {
// Exclude files that conflict with backend static resources
exclude 'robots.txt' // Backend already has this
exclude 'favicon.ico' // Backend already has this
}
into resourcesStaticDir
duplicatesStrategy = DuplicatesStrategy.INCLUDE // Let frontend overwrite when needed
doFirst {
println "Copying frontend build from ${frontendDistDir} to ${resourcesStaticDir}..."
println "Backend static resources will be preserved"
}
doLast {
println "Frontend assets copied successfully!"
}
}
tasks.register('cleanFrontendAssets', Delete) {
group = 'frontend'
description = 'Remove previously generated frontend assets from static resources'
delete generatedFrontendPaths.collect { new File(resourcesStaticDir, it) }
}
// Ensure copyFrontendAssets runs after spotless tasks
tasks.named('copyFrontendAssets').configure {
mustRunAfter tasks.matching { it.name.startsWith('spotless') }
}
if (buildWithFrontend) {
println "Frontend build enabled - JAR will include React frontend"
processResources.dependsOn copyFrontendAssets
} else {
println "Frontend build disabled - JAR will be backend-only"
// When not building the UI, ensure any stale frontend assets are removed
processResources.dependsOn cleanFrontendAssets
}
bootJar.dependsOn ':common:jar'
bootJar.dependsOn ':proprietary:jar'
@@ -95,7 +95,7 @@ public class InitialSetup {
isNewServer =
existingVersion == null
|| existingVersion.isEmpty()
|| existingVersion.equals("0.0.0");
|| "0.0.0".equals(existingVersion);
String appVersion = "0.0.0";
Resource resource = new ClassPathResource("version.properties");
@@ -72,6 +72,7 @@ import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.extern.slf4j.Slf4j;
import stirling.software.SPDF.config.swagger.StandardPdfResponse;
import stirling.software.SPDF.model.api.security.MultiSignPDFWithCertRequest;
import stirling.software.SPDF.model.api.security.SignPDFWithCertRequest;
import stirling.software.common.annotations.AutoJobPostMapping;
import stirling.software.common.service.CustomPDFDocumentFactory;
@@ -113,7 +114,7 @@ public class CertSignController {
this.serverCertificateService = serverCertificateService;
}
private static void sign(
static void sign(
CustomPDFDocumentFactory pdfDocumentFactory,
MultipartFile input,
OutputStream output,
@@ -149,6 +150,42 @@ public class CertSignController {
}
}
static void sign(
CustomPDFDocumentFactory pdfDocumentFactory,
InputStream input,
OutputStream output,
CreateSignature instance,
Boolean showSignature,
Integer pageNumber,
String name,
String location,
String reason,
Boolean showLogo) {
try (PDDocument doc = pdfDocumentFactory.load(input)) {
PDSignature signature = new PDSignature();
signature.setFilter(PDSignature.FILTER_ADOBE_PPKLITE);
signature.setSubFilter(PDSignature.SUBFILTER_ADBE_PKCS7_DETACHED);
signature.setName(name);
signature.setLocation(location);
signature.setReason(reason);
signature.setSignDate(Calendar.getInstance());
if (Boolean.TRUE.equals(showSignature)) {
SignatureOptions signatureOptions = new SignatureOptions();
signatureOptions.setVisualSignature(
instance.createVisibleSignature(doc, signature, pageNumber, showLogo));
signatureOptions.setPage(pageNumber);
doc.addSignature(signature, instance, signatureOptions);
} else {
doc.addSignature(signature, instance);
}
doc.saveIncremental(output);
} catch (Exception e) {
ExceptionUtils.logException("PDF signing", e);
}
}
@AutoJobPostMapping(
consumes = {
MediaType.MULTIPART_FORM_DATA_VALUE,
@@ -251,7 +288,143 @@ public class CertSignController {
GeneralUtils.generateFilename(pdf.getOriginalFilename(), "_signed.pdf"));
}
private PrivateKey getPrivateKeyFromPEM(byte[] pemBytes, String password)
@AutoJobPostMapping(
consumes = {
MediaType.MULTIPART_FORM_DATA_VALUE,
MediaType.APPLICATION_FORM_URLENCODED_VALUE
},
value = "/cert-sign/multi")
@StandardPdfResponse
@Operation(
summary = "Sign PDF with multiple Digital Certificates",
description =
"This endpoint accepts a PDF file and multiple digital certificates to"
+ " sequentially sign the document. Input:PDF Output:PDF Type:SISO")
public ResponseEntity<byte[]> multiSignPDFWithCert(
@ModelAttribute MultiSignPDFWithCertRequest request) throws Exception {
if (request.getCertTypes() == null || request.getCertTypes().isEmpty()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"certificate types");
}
byte[] currentPdf = request.getFileInput().getBytes();
String originalFilename = request.getFileInput().getOriginalFilename();
for (int i = 0; i < request.getCertTypes().size(); i++) {
String certType = request.getCertTypes().get(i);
KeyStore ks = null;
String keystorePassword = getFromList(request.getPasswords(), i, "");
switch (certType) {
case "PEM":
ks = KeyStore.getInstance("JKS");
ks.load(null);
MultipartFile privateKeyFile =
getFromList(request.getPrivateKeyFiles(), i, null);
MultipartFile certFile = getFromList(request.getCertFiles(), i, null);
if (privateKeyFile == null || certFile == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"certificate and key files for signer " + (i + 1));
}
PrivateKey privateKey =
getPrivateKeyFromPEM(privateKeyFile.getBytes(), keystorePassword);
Certificate cert = (Certificate) getCertificateFromPEM(certFile.getBytes());
ks.setKeyEntry(
"alias",
privateKey,
keystorePassword.toCharArray(),
new Certificate[] {cert});
break;
case "PKCS12":
case "PFX":
MultipartFile p12File = getFromList(request.getP12Files(), i, null);
if (p12File == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"PKCS12/PFX keystore for signer " + (i + 1));
}
ks = KeyStore.getInstance("PKCS12");
ks.load(p12File.getInputStream(), keystorePassword.toCharArray());
break;
case "JKS":
MultipartFile jksfile = getFromList(request.getJksFiles(), i, null);
if (jksfile == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"JKS keystore for signer " + (i + 1));
}
ks = KeyStore.getInstance("JKS");
ks.load(jksfile.getInputStream(), keystorePassword.toCharArray());
break;
case "SERVER":
if (serverCertificateService == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.serverCertificateNotAvailable",
"Server certificate service is not available in this edition");
}
if (!serverCertificateService.isEnabled()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.serverCertificateDisabled",
"Server certificate feature is disabled");
}
if (!serverCertificateService.hasServerCertificate()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.serverCertificateNotFound",
"No server certificate configured");
}
ks = serverCertificateService.getServerKeyStore();
keystorePassword = serverCertificateService.getServerCertificatePassword();
break;
default:
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidArgument",
"Invalid argument: {0}",
"certificate type: " + certType);
}
CreateSignature createSignature =
new CreateSignature(ks, keystorePassword.toCharArray());
ByteArrayOutputStream baos = new ByteArrayOutputStream();
String signerName = getFromList(request.getNames(), i, "SPDF");
String location = getFromList(request.getLocations(), i, "SPDF");
String reason = getFromList(request.getReasons(), i, "Signed by SPDF");
Boolean showSignature = getFromList(request.getShowSignatures(), i, Boolean.FALSE);
Boolean showLogo = getFromList(request.getShowLogos(), i, Boolean.TRUE);
Integer pageNumber = getFromList(request.getPageNumbers(), i, null);
pageNumber = pageNumber != null ? pageNumber - 1 : null;
sign(
pdfDocumentFactory,
new ByteArrayInputStream(currentPdf),
baos,
createSignature,
showSignature,
pageNumber,
signerName,
location,
reason,
showLogo);
currentPdf = baos.toByteArray();
}
return WebResponseUtils.bytesToWebResponse(
currentPdf, GeneralUtils.generateFilename(originalFilename, "_multi_signed.pdf"));
}
private static <T> T getFromList(List<T> list, int index, T defaultValue) {
if (list == null || list.size() <= index) {
return defaultValue;
}
return list.get(index);
}
public PrivateKey getPrivateKeyFromPEM(byte[] pemBytes, String password)
throws IOException, OperatorCreationException, PKCSException {
try (PEMParser pemParser =
new PEMParser(new InputStreamReader(new ByteArrayInputStream(pemBytes)))) {
@@ -273,14 +446,14 @@ public class CertSignController {
}
}
private Certificate getCertificateFromPEM(byte[] pemBytes)
public Certificate getCertificateFromPEM(byte[] pemBytes)
throws IOException, CertificateException {
try (ByteArrayInputStream bis = new ByteArrayInputStream(pemBytes)) {
return CertificateFactory.getInstance("X.509").generateCertificate(bis);
}
}
class CreateSignature extends CreateSignatureBase {
static class CreateSignature extends CreateSignatureBase {
File logoFile;
public CreateSignature(KeyStore keystore, char[] pin)
@@ -0,0 +1,678 @@
package stirling.software.SPDF.controller.api.security;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.security.KeyStore;
import java.security.Principal;
import java.security.PrivateKey;
import java.security.cert.Certificate;
import java.util.List;
import java.util.Locale;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.constraints.NotBlank;
import lombok.extern.slf4j.Slf4j;
import stirling.software.SPDF.config.swagger.StandardPdfResponse;
import stirling.software.SPDF.controller.api.security.CertSignController.CreateSignature;
import stirling.software.SPDF.service.SigningSessionService;
import stirling.software.common.model.api.security.*;
import stirling.software.common.service.CustomPDFDocumentFactory;
import stirling.software.common.service.ServerCertificateServiceInterface;
import stirling.software.common.service.SigningSessionServiceInterface;
import stirling.software.common.util.ExceptionUtils;
import stirling.software.common.util.GeneralUtils;
import stirling.software.common.util.WebResponseUtils;
import stirling.software.proprietary.service.UserServerCertificateService;
@Slf4j
@RestController
@RequestMapping("/api/v1/security")
@Tag(name = "Security", description = "Security APIs")
public class SigningSessionController {
private final SigningSessionService signingSessionService;
private final CustomPDFDocumentFactory pdfDocumentFactory;
private final ServerCertificateServiceInterface serverCertificateServiceInterface;
private final SigningSessionServiceInterface sessionServiceInterface;
private final UserServerCertificateService userServerCertificateService;
public SigningSessionController(
SigningSessionService signingSessionService,
CustomPDFDocumentFactory pdfDocumentFactory,
@Autowired(required = false)
ServerCertificateServiceInterface serverCertificateServiceInterface,
@Autowired(required = false)
List<SigningSessionServiceInterface> signingSessionServices,
@Autowired(required = false)
UserServerCertificateService userServerCertificateService) {
this.signingSessionService = signingSessionService;
this.pdfDocumentFactory = pdfDocumentFactory;
this.serverCertificateServiceInterface = serverCertificateServiceInterface;
this.userServerCertificateService = userServerCertificateService;
// Use database-backed service if available, otherwise fall back to in-memory
this.sessionServiceInterface =
signingSessionServices != null && !signingSessionServices.isEmpty()
? signingSessionServices.stream()
.filter(SigningSessionServiceInterface::isDatabaseBacked)
.findFirst()
.orElse(signingSessionService)
: signingSessionService;
}
@Operation(summary = "List all signing sessions for current user")
@GetMapping(value = "/cert-sign/sessions")
public ResponseEntity<?> listSessions(Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Authentication required");
}
try {
List<?> sessions = sessionServiceInterface.listUserSessions(principal.getName());
return ResponseEntity.ok(sessions);
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
.body("Error listing sessions");
}
}
@PostMapping(
consumes = {
MediaType.MULTIPART_FORM_DATA_VALUE,
MediaType.APPLICATION_FORM_URLENCODED_VALUE
},
value = "/cert-sign/sessions",
produces = MediaType.APPLICATION_JSON_VALUE)
@Operation(
summary = "Create a shared signing session",
description =
"Starts a collaboration session, distributes share links, and optionally notifies participants."
+ " Input:PDF Output:JSON Type:SISO")
public ResponseEntity<?> createSession(
@ModelAttribute CreateSigningSessionRequest request, Principal principal)
throws Exception {
if (sessionServiceInterface.isDatabaseBacked() && principal != null) {
Object session = sessionServiceInterface.createSession(request, principal.getName());
return ResponseEntity.ok(session);
} else {
SigningSession session = signingSessionService.createSession(request);
return ResponseEntity.ok(session);
}
}
@Operation(summary = "Fetch signing session details")
@GetMapping(value = "/cert-sign/sessions/{sessionId}")
public ResponseEntity<?> getSession(
@PathVariable("sessionId") @NotBlank String sessionId, Principal principal) {
if (sessionServiceInterface.isDatabaseBacked() && principal != null) {
try {
Object session =
sessionServiceInterface.getSessionDetail(sessionId, principal.getName());
return ResponseEntity.ok(session);
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN)
.body("Access denied or session not found");
}
} else {
SigningSession session = signingSessionService.getSession(sessionId);
return ResponseEntity.ok(session);
}
}
@Operation(summary = "Delete a signing session")
@DeleteMapping(value = "/cert-sign/sessions/{sessionId}")
public ResponseEntity<?> deleteSession(
@PathVariable("sessionId") @NotBlank String sessionId, Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Authentication required");
}
try {
sessionServiceInterface.deleteSession(sessionId, principal.getName());
return ResponseEntity.noContent().build();
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN)
.body("Cannot delete session: " + e.getMessage());
}
}
@Operation(summary = "Add participants to an existing session")
@PostMapping(value = "/cert-sign/sessions/{sessionId}/participants")
public ResponseEntity<?> addParticipants(
@PathVariable("sessionId") @NotBlank String sessionId,
@RequestBody AddParticipantsRequest request,
Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Authentication required");
}
try {
Object session =
sessionServiceInterface.addParticipants(
sessionId, request, principal.getName());
return ResponseEntity.ok(session);
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN)
.body("Cannot add participants: " + e.getMessage());
}
}
@Operation(summary = "Remove a participant from a session")
@DeleteMapping(value = "/cert-sign/sessions/{sessionId}/participants/{userId}")
public ResponseEntity<?> removeParticipant(
@PathVariable("sessionId") @NotBlank String sessionId,
@PathVariable("userId") Long userId,
Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Authentication required");
}
try {
sessionServiceInterface.removeParticipant(sessionId, userId, principal.getName());
return ResponseEntity.noContent().build();
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN)
.body("Cannot remove participant: " + e.getMessage());
}
}
@Operation(summary = "Get session PDF for participant view")
@GetMapping(value = "/cert-sign/sessions/{sessionId}/pdf")
public ResponseEntity<byte[]> getSessionPdf(
@PathVariable("sessionId") @NotBlank String sessionId, Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build();
}
try {
byte[] pdfBytes = sessionServiceInterface.getSessionPdf(sessionId, principal.getName());
return WebResponseUtils.bytesToWebResponse(pdfBytes, "document.pdf");
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN).build();
}
}
@PostMapping(value = "/cert-sign/sessions/{sessionId}/notify")
@Operation(summary = "Notify signing participants about outstanding requests")
public SigningSession notifyParticipants(
@PathVariable("sessionId") @NotBlank String sessionId,
@RequestBody NotifySigningParticipantsRequest request) {
return (SigningSession) sessionServiceInterface.notifyParticipants(sessionId, request);
}
@PostMapping(
value = "/cert-sign/sessions/{sessionId}/participants/{userId}/certificate",
consumes = {
MediaType.MULTIPART_FORM_DATA_VALUE,
MediaType.APPLICATION_FORM_URLENCODED_VALUE
})
@Operation(summary = "Attach certificate details for a specific participant")
public SigningSession attachCertificate(
@PathVariable("sessionId") @NotBlank String sessionId,
@PathVariable("userId") Long userId,
@ModelAttribute ParticipantCertificateRequest request)
throws Exception {
return (SigningSession)
sessionServiceInterface.attachCertificate(sessionId, userId, request);
}
@Operation(summary = "Get signed PDF from finalized session")
@GetMapping(value = "/cert-sign/sessions/{sessionId}/signed-pdf")
@StandardPdfResponse
public ResponseEntity<byte[]> getSignedPdf(
@PathVariable("sessionId") @NotBlank String sessionId, Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build();
}
try {
byte[] signedPdf = sessionServiceInterface.getSignedPdf(sessionId, principal.getName());
if (signedPdf == null) {
return ResponseEntity.status(HttpStatus.NOT_FOUND)
.body("Session not finalized".getBytes());
}
SigningSession session = (SigningSession) sessionServiceInterface.getSession(sessionId);
return WebResponseUtils.bytesToWebResponse(
signedPdf,
GeneralUtils.generateFilename(session.getDocumentName(), "_shared_signed.pdf"));
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN).build();
}
}
@PostMapping(value = "/cert-sign/sessions/{sessionId}/finalize")
@Operation(
summary = "Finalize signing session",
description =
"Applies collected certificates in order and returns the signed document.")
@StandardPdfResponse
public ResponseEntity<byte[]> finalizeSession(
@PathVariable("sessionId") @NotBlank String sessionId, Principal principal)
throws Exception {
// Validate ownership if database service is available
if (sessionServiceInterface.isDatabaseBacked() && principal != null) {
try {
sessionServiceInterface.getSessionDetail(sessionId, principal.getName());
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN).build();
}
}
SigningSession session = (SigningSession) sessionServiceInterface.getSession(sessionId);
byte[] pdf = session.getOriginalPdf();
// Step 1: Apply wet signatures (visual annotations) FIRST
if (sessionServiceInterface.isDatabaseBacked()) {
try {
pdf = applyWetSignatures(pdf, sessionId);
} catch (Exception e) {
log.error(
"Failed to apply wet signatures for session {}: {}",
sessionId,
e.getMessage());
// Continue with certificate signing even if wet signatures fail
}
}
// Step 2: Apply digital certificates
for (SigningParticipant participant : session.getParticipants()) {
ParticipantCertificateSubmission submission = participant.getCertificateSubmission();
if (submission == null || participant.getStatus() != ParticipantStatus.SIGNED) {
continue;
}
// Skip SERVER certificate type if feature is not available/enabled
if ("SERVER".equalsIgnoreCase(submission.getCertType())) {
if (serverCertificateServiceInterface == null
|| !serverCertificateServiceInterface.isEnabled()
|| !serverCertificateServiceInterface.hasServerCertificate()) {
// Skip this participant - server certificate not available
continue;
}
}
// Handle USER_CERT type - auto-generate if needed
if ("USER_CERT".equalsIgnoreCase(submission.getCertType())) {
if (userServerCertificateService == null
|| !sessionServiceInterface.isDatabaseBacked()) {
log.warn(
"USER_CERT requested but service not available, skipping participant: {}",
participant.getEmail());
continue;
}
}
KeyStore keystore = buildKeystore(submission, participant);
boolean usingServer = "SERVER".equalsIgnoreCase(submission.getCertType());
boolean usingUserCert = "USER_CERT".equalsIgnoreCase(submission.getCertType());
String password;
if (usingServer && serverCertificateServiceInterface != null) {
password = serverCertificateServiceInterface.getServerCertificatePassword();
} else if (usingUserCert && userServerCertificateService != null) {
password = submission.getPassword(); // Password stored in submission for user cert
} else {
password = submission.getPassword();
}
CreateSignature createSignature =
new CreateSignature(
keystore, password != null ? password.toCharArray() : new char[0]);
ByteArrayOutputStream baos = new ByteArrayOutputStream();
CertSignController.sign(
pdfDocumentFactory,
new ByteArrayInputStream(pdf),
baos,
createSignature,
submission.getShowSignature(),
submission.getPageNumber() != null
? Math.max(submission.getPageNumber() - 1, 0)
: null,
StringUtils.defaultIfBlank(participant.getName(), "Shared Signing"),
StringUtils.defaultIfBlank(submission.getLocation(), ""),
StringUtils.defaultIfBlank(submission.getReason(), "Document Signing"),
submission.getShowLogo());
pdf = baos.toByteArray();
}
session.setSignedPdf(pdf);
// Mark session as finalized in database if database service is available
sessionServiceInterface.markSessionFinalized(sessionId, pdf);
// Step 3: Clean up wet signature metadata (GDPR compliance)
if (sessionServiceInterface.isDatabaseBacked()) {
try {
clearWetSignatureMetadata(sessionId);
} catch (Exception e) {
log.error(
"Failed to clear wet signature metadata for session {}: {}",
sessionId,
e.getMessage());
// Don't fail the finalization if cleanup fails
}
}
return WebResponseUtils.bytesToWebResponse(
pdf,
GeneralUtils.generateFilename(session.getDocumentName(), "_shared_signed.pdf"));
}
private KeyStore buildKeystore(
ParticipantCertificateSubmission submission, SigningParticipant participant)
throws Exception {
CertSignController certSignController =
new CertSignController(pdfDocumentFactory, serverCertificateServiceInterface);
String certType = submission.getCertType().toUpperCase(Locale.ROOT);
String password = submission.getPassword();
switch (certType) {
case "USER_CERT":
if (userServerCertificateService == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.userCertificateNotAvailable",
"User certificate service is not available in this edition");
}
// Get user ID from participant
Long userId = getUserIdFromParticipant(participant);
if (userId == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.userNotFound", "Cannot determine user ID for participant");
}
// Auto-generate certificate if user doesn't have one
try {
userServerCertificateService.getOrCreateUserCertificate(userId);
KeyStore userKeyStore = userServerCertificateService.getUserKeyStore(userId);
String userPassword =
userServerCertificateService.getUserKeystorePassword(userId);
// Store password in submission for later use
submission.setPassword(userPassword);
return userKeyStore;
} catch (Exception e) {
log.error("Failed to get/create user certificate for user {}", userId, e);
throw ExceptionUtils.createIllegalArgumentException(
"error.userCertificateFailure",
"Failed to get user certificate: " + e.getMessage());
}
case "PEM":
KeyStore pemStore = KeyStore.getInstance("JKS");
pemStore.load(null);
if (submission.getPrivateKey() == null || submission.getCertificate() == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"PEM certificate and key bytes for signer");
}
PrivateKey privateKey =
certSignController.getPrivateKeyFromPEM(
submission.getPrivateKey(), password);
Certificate certificate =
(Certificate)
certSignController.getCertificateFromPEM(
submission.getCertificate());
pemStore.setKeyEntry(
"alias",
privateKey,
password.toCharArray(),
new Certificate[] {certificate});
return pemStore;
case "PKCS12":
case "PFX":
if (submission.getP12Keystore() == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"PKCS12 keystore bytes");
}
KeyStore p12Store = KeyStore.getInstance("PKCS12");
p12Store.load(
new ByteArrayInputStream(submission.getP12Keystore()),
password.toCharArray());
return p12Store;
case "JKS":
if (submission.getJksKeystore() == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"JKS keystore bytes");
}
KeyStore jksStore = KeyStore.getInstance("JKS");
jksStore.load(
new ByteArrayInputStream(submission.getJksKeystore()),
password.toCharArray());
return jksStore;
case "SERVER":
if (serverCertificateServiceInterface == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.serverCertificateNotAvailable",
"Server certificate service is not available in this edition");
}
if (!serverCertificateServiceInterface.isEnabled()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.serverCertificateDisabled",
"Server certificate feature is disabled");
}
if (!serverCertificateServiceInterface.hasServerCertificate()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.serverCertificateNotFound", "No server certificate configured");
}
return serverCertificateServiceInterface.getServerKeyStore();
default:
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidArgument",
"Invalid argument: {0}",
"certificate type: " + submission.getCertType());
}
}
/**
* Applies wet signatures (visual annotations) to the PDF. This must be done BEFORE applying
* digital certificates.
*
* @param pdfBytes Original PDF bytes
* @param sessionId Session ID
* @return PDF bytes with wet signatures overlaid
* @throws Exception if PDF processing fails
*/
private byte[] applyWetSignatures(byte[] pdfBytes, String sessionId) throws Exception {
// Cast to database service to access wet signature methods
if (!(sessionServiceInterface
instanceof
stirling.software.proprietary.security.service.DatabaseSigningSessionService)) {
return pdfBytes; // Skip if not database service
}
stirling.software.proprietary.security.service.DatabaseSigningSessionService dbService =
(stirling.software.proprietary.security.service.DatabaseSigningSessionService)
sessionServiceInterface;
List<WetSignatureMetadata> wetSignatures = dbService.getAllWetSignatures(sessionId);
if (wetSignatures.isEmpty()) {
return pdfBytes; // No wet signatures to apply
}
// Load PDF document
org.apache.pdfbox.pdmodel.PDDocument document =
pdfDocumentFactory.load(new ByteArrayInputStream(pdfBytes));
try {
for (WetSignatureMetadata wetSig : wetSignatures) {
applyWetSignatureToPage(document, wetSig);
}
// Save modified PDF
ByteArrayOutputStream baos = new ByteArrayOutputStream();
document.save(baos);
return baos.toByteArray();
} finally {
document.close();
}
}
/**
* Applies a single wet signature to the appropriate page of the PDF.
*
* @param document PDF document
* @param wetSig Wet signature metadata
* @throws Exception if image processing or PDF manipulation fails
*/
private void applyWetSignatureToPage(
org.apache.pdfbox.pdmodel.PDDocument document, WetSignatureMetadata wetSig)
throws Exception {
if (wetSig.getPage() >= document.getNumberOfPages()) {
log.warn(
"Wet signature page {} exceeds document pages {}, skipping",
wetSig.getPage(),
document.getNumberOfPages());
return;
}
org.apache.pdfbox.pdmodel.PDPage page = document.getPage(wetSig.getPage());
org.apache.pdfbox.pdmodel.PDPageContentStream contentStream =
new org.apache.pdfbox.pdmodel.PDPageContentStream(
document,
page,
org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode.APPEND,
true,
true);
try {
// Extract base64 data (remove data:image/png;base64, prefix if present)
String base64Data = wetSig.extractBase64Data();
byte[] imageBytes = java.util.Base64.getDecoder().decode(base64Data);
// Create PDImageXObject from bytes
org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject image =
org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject.createFromByteArray(
document, imageBytes, "signature");
// Convert Y coordinate from UI (top-left) to PDF (bottom-left) coordinate system
float pdfY =
page.getMediaBox().getHeight()
- wetSig.getY().floatValue()
- wetSig.getHeight().floatValue();
// Draw image at specified position
contentStream.drawImage(
image,
wetSig.getX().floatValue(),
pdfY,
wetSig.getWidth().floatValue(),
wetSig.getHeight().floatValue());
} finally {
contentStream.close();
}
}
/**
* Clears wet signature metadata from all participants. Called after successful finalization for
* GDPR compliance.
*
* @param sessionId Session ID
*/
private void clearWetSignatureMetadata(String sessionId) {
if (sessionServiceInterface
instanceof
stirling.software.proprietary.security.service.DatabaseSigningSessionService) {
stirling.software.proprietary.security.service.DatabaseSigningSessionService dbService =
(stirling.software.proprietary.security.service.DatabaseSigningSessionService)
sessionServiceInterface;
dbService.clearWetSignatureMetadata(sessionId);
}
}
/**
* Helper method to get user ID from participant. Returns null if not available (e.g., in-memory
* sessions).
*
* @param participant The signing participant
* @return User ID or null
*/
private Long getUserIdFromParticipant(SigningParticipant participant) {
return participant.getUserId();
}
@Operation(summary = "List sign requests for authenticated user")
@GetMapping(value = "/cert-sign/sign-requests")
public ResponseEntity<?> listSignRequests(Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Authentication required");
}
try {
return ResponseEntity.ok(sessionServiceInterface.listSignRequests(principal.getName()));
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
.body("Cannot list sign requests: " + e.getMessage());
}
}
@Operation(summary = "Get sign request detail for participant")
@GetMapping(value = "/cert-sign/sign-requests/{sessionId}")
public ResponseEntity<?> getSignRequestDetail(
@PathVariable("sessionId") @NotBlank String sessionId, Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Authentication required");
}
try {
return ResponseEntity.ok(
sessionServiceInterface.getSignRequestDetail(sessionId, principal.getName()));
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN)
.body("Access denied or sign request not found: " + e.getMessage());
}
}
@Operation(summary = "Decline a sign request")
@PostMapping(value = "/cert-sign/sign-requests/{sessionId}/decline")
public ResponseEntity<?> declineSignRequest(
@PathVariable("sessionId") @NotBlank String sessionId, Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Authentication required");
}
try {
sessionServiceInterface.declineSignRequest(sessionId, principal.getName());
return ResponseEntity.noContent().build();
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.FORBIDDEN)
.body("Cannot decline sign request: " + e.getMessage());
}
}
@Operation(
summary = "Sign a document with optional wet signature",
description =
"Submits certificate and optional wet signature annotation metadata for a signing session")
@PostMapping(
value = "/cert-sign/sessions/{sessionId}/sign",
consumes = {
MediaType.MULTIPART_FORM_DATA_VALUE,
MediaType.APPLICATION_FORM_URLENCODED_VALUE
})
public ResponseEntity<?> signDocument(
@PathVariable("sessionId") @NotBlank String sessionId,
@ModelAttribute SignDocumentRequest request,
Principal principal) {
if (principal == null || !sessionServiceInterface.isDatabaseBacked()) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("Authentication required");
}
try {
sessionServiceInterface.signDocument(sessionId, principal.getName(), request);
return ResponseEntity.noContent().build();
} catch (IllegalArgumentException e) {
return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
} catch (Exception e) {
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
.body("Cannot sign document: " + e.getMessage());
}
}
}
@@ -1,16 +1,19 @@
package stirling.software.SPDF.controller.web;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
// @Controller // Disabled - Backend-only mode, no Thymeleaf UI
@Controller
public class ReactRoutingController {
@GetMapping("/{path:^(?!api|static|robots\\.txt|favicon\\.ico)[^\\.]*$}")
@GetMapping(
"/{path:^(?!api|static|robots\\.txt|favicon\\.ico|pipeline|pdfjs|pdfjs-legacy|fonts|images|files|css|js)[^\\.]*$}")
public String forwardRootPaths() {
return "forward:/index.html";
}
@GetMapping("/{path:^(?!api|static)[^\\.]*}/{subpath:^(?!.*\\.).*$}")
@GetMapping(
"/{path:^(?!api|static|pipeline|pdfjs|pdfjs-legacy|fonts|images|files|css|js)[^\\.]*}/{subpath:^(?!.*\\.).*$}")
public String forwardNestedPaths() {
return "forward:/index.html";
}
@@ -0,0 +1,68 @@
package stirling.software.SPDF.model.api.security;
import java.util.List;
import org.springframework.web.multipart.MultipartFile;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import stirling.software.common.model.api.PDFFile;
@Data
@EqualsAndHashCode(callSuper = true)
public class MultiSignPDFWithCertRequest extends PDFFile {
@Schema(
description = "The list of certificate types for each signer",
allowableValues = {"PEM", "PKCS12", "PFX", "JKS", "SERVER"},
requiredMode = Schema.RequiredMode.REQUIRED)
private List<String> certTypes;
@Schema(
description =
"Private key files for PEM certificates (supports .pem, .der, or .key files)."
+ " Should match the order of certTypes when PEM is selected")
private List<MultipartFile> privateKeyFiles;
@Schema(
description =
"Certificate files for PEM certificates (supports .pem, .der, .crt, or .cer files)."
+ " Should match the order of certTypes when PEM is selected")
private List<MultipartFile> certFiles;
@Schema(
description =
"PKCS12/PFX keystore files. Should match the order of certTypes when PKCS12 or PFX is selected")
private List<MultipartFile> p12Files;
@Schema(
description =
"JKS keystore files. Should match the order of certTypes when JKS is selected")
private List<MultipartFile> jksFiles;
@Schema(description = "Passwords for keystores or private keys", format = "password")
private List<String> passwords;
@Schema(description = "Whether to visually show each signature in the PDF")
private List<Boolean> showSignatures;
@Schema(description = "Reasons for signing, aligned with certTypes")
private List<String> reasons;
@Schema(description = "Locations for signing, aligned with certTypes")
private List<String> locations;
@Schema(description = "Signer names, aligned with certTypes")
private List<String> names;
@Schema(
description =
"Page numbers for visible signatures (1-indexed). Required when showSignature is true for a signer")
private List<Integer> pageNumbers;
@Schema(description = "Whether to show a signature logo for each signer")
private List<Boolean> showLogos;
}
@@ -0,0 +1,214 @@
package stirling.software.SPDF.service;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;
import stirling.software.common.model.api.security.CreateSigningSessionRequest;
import stirling.software.common.model.api.security.NotifySigningParticipantsRequest;
import stirling.software.common.model.api.security.ParticipantCertificateRequest;
import stirling.software.common.model.api.security.ParticipantCertificateSubmission;
import stirling.software.common.model.api.security.ParticipantStatus;
import stirling.software.common.model.api.security.SigningParticipant;
import stirling.software.common.model.api.security.SigningSession;
import stirling.software.common.service.SigningSessionServiceInterface;
import stirling.software.common.util.ExceptionUtils;
@Service
public class SigningSessionService implements SigningSessionServiceInterface {
private final Map<String, SigningSession> sessions = new ConcurrentHashMap<>();
public SigningSession createSession(CreateSigningSessionRequest request) throws IOException {
return createSession(request, null);
}
@Override
public SigningSession createSession(Object requestObj, String username) throws IOException {
// In-memory implementation not supported for user-based signing (requires database)
throw new UnsupportedOperationException(
"User-based signing requires database-backed implementation");
}
public SigningSession getSession(String sessionId) {
SigningSession session = sessions.get(sessionId);
if (session == null) {
throw ExceptionUtils.createIllegalArgumentException(
"error.notFound", "Signing session {0} was not found", sessionId);
}
return session;
}
@Override
public SigningSession notifyParticipants(String sessionId, Object requestObj) {
NotifySigningParticipantsRequest request = (NotifySigningParticipantsRequest) requestObj;
SigningSession session = getSession(sessionId);
List<SigningParticipant> targets = getTargets(session, request.getParticipantEmails());
String message =
StringUtils.defaultIfBlank(
request.getMessage(), "A reminder to review and sign the document.");
for (SigningParticipant participant : targets) {
participant.recordNotification(message);
if (participant.getStatus() == ParticipantStatus.PENDING) {
participant.setStatus(ParticipantStatus.NOTIFIED);
}
}
session.touch();
return session;
}
@Override
public SigningSession attachCertificate(String sessionId, Long userId, Object requestObj)
throws IOException {
// In-memory implementation doesn't support user-based participants
throw new UnsupportedOperationException(
"User-based signing not supported in non-database mode");
}
private void broadcastNotification(SigningSession session, String message) {
for (SigningParticipant participant : session.getParticipants()) {
participant.recordNotification(message);
if (participant.getStatus() == ParticipantStatus.PENDING) {
participant.setStatus(ParticipantStatus.NOTIFIED);
}
}
session.touch();
}
private ParticipantCertificateSubmission toSubmission(ParticipantCertificateRequest request)
throws IOException {
return ParticipantCertificateSubmission.builder()
.certType(request.getCertType())
.password(request.getPassword())
.privateKey(toBytes(request.getPrivateKeyFile()))
.certificate(toBytes(request.getCertFile()))
.p12Keystore(toBytes(request.getP12File()))
.jksKeystore(toBytes(request.getJksFile()))
.showSignature(request.getShowSignature())
.pageNumber(request.getPageNumber())
.name(request.getName())
.reason(request.getReason())
.location(request.getLocation())
.showLogo(request.getShowLogo())
.build();
}
private byte[] toBytes(MultipartFile file) throws IOException {
if (file == null || file.isEmpty()) {
return null;
}
return file.getBytes();
}
private List<SigningParticipant> getTargets(
SigningSession session, List<String> requestedEmails) {
if (requestedEmails == null || requestedEmails.isEmpty()) {
return session.getParticipants();
}
List<SigningParticipant> participants = new ArrayList<>();
for (String email : requestedEmails) {
Optional<SigningParticipant> participant =
session.getParticipants().stream()
.filter(p -> Objects.equals(p.getEmail(), email))
.findFirst();
participant.ifPresent(participants::add);
}
return participants;
}
// Interface methods that are not supported by in-memory implementation
@Override
public List<?> listUserSessions(String username) {
// In-memory implementation doesn't support user filtering
return Collections.emptyList();
}
@Override
public Object getSessionDetail(String sessionId, String username) {
// In-memory implementation doesn't have separate detail view
return getSession(sessionId);
}
@Override
public void deleteSession(String sessionId, String username) {
// In-memory implementation doesn't support deletion
throw new UnsupportedOperationException(
"Session deletion not supported in non-database mode");
}
@Override
public Object addParticipants(String sessionId, Object request, String username) {
// In-memory implementation doesn't support adding participants
throw new UnsupportedOperationException(
"Adding participants not supported in non-database mode");
}
@Override
public void removeParticipant(String sessionId, Long userId, String username) {
// In-memory implementation doesn't support user-based participants
throw new UnsupportedOperationException(
"User-based signing not supported in non-database mode");
}
@Override
public void markSessionFinalized(String sessionId, byte[] signedPdf) {
SigningSession session = getSession(sessionId);
session.setSignedPdf(signedPdf);
}
@Override
public byte[] getSessionPdf(String sessionId, String username) {
// In-memory implementation doesn't support user authentication
throw new UnsupportedOperationException(
"User-based signing not supported in non-database mode");
}
@Override
public byte[] getSignedPdf(String sessionId, String username) {
throw new UnsupportedOperationException(
"getSignedPdf is only available in database-backed mode");
}
@Override
public List<?> listSignRequests(String username) {
// In-memory implementation doesn't support user-based sign requests
return Collections.emptyList();
}
@Override
public Object getSignRequestDetail(String sessionId, String username) {
// In-memory implementation doesn't support user-based signing
throw new UnsupportedOperationException(
"User-based signing not supported in non-database mode");
}
@Override
public void declineSignRequest(String sessionId, String username) {
// In-memory implementation doesn't support user-based signing
throw new UnsupportedOperationException(
"User-based signing not supported in non-database mode");
}
@Override
public void signDocument(String sessionId, String username, Object request) throws IOException {
// In-memory implementation doesn't support user-based signing with wet signatures
throw new UnsupportedOperationException(
"User-based signing not supported in non-database mode");
}
@Override
public boolean isDatabaseBacked() {
return false;
}
}
@@ -37,8 +37,11 @@ spring.datasource.url=jdbc:h2:file:./configs/stirling-pdf-DB-2.3.232;DB_CLOSE_DE
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.h2.console.enabled=false
spring.h2.console.enabled=true
spring.jpa.hibernate.ddl-auto=update
spring.jpa.properties.hibernate.format_sql=true
logging.level.org.hibernate.SQL=error
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE
# Defer datasource initialization to ensure that the database is fully set up
# before Hibernate attempts to access it. This is particularly useful when
# using database initialization scripts or tools.
@@ -52,7 +55,7 @@ server.servlet.session.timeout:30m
springdoc.api-docs.path=/v1/api-docs
# Set the URL of the OpenAPI JSON for the Swagger UI
springdoc.swagger-ui.url=/v1/api-docs
springdoc.swagger-ui.path=/index.html
springdoc.swagger-ui.path=/swagger-ui.html
# Force OpenAPI 3.0 specification version
springdoc.api-docs.version=OPENAPI_3_0
posthog.api.key=phc_fiR65u5j6qmXTYL56MNrLZSWqLaDW74OrZH0Insd2xq
@@ -65,3 +68,9 @@ java.io.tmpdir=${stirling.tempfiles.directory:${java.io.tmpdir}/stirling-pdf}
# V2 features
v2=true
# User personal certificates (per-user signing certificates)
system.userCertificates.enabled=true
system.userCertificates.autoGenerate=true
system.userCertificates.validity=365
system.userCertificates.keySize=2048
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
@@ -76,4 +76,9 @@
.cm__btns{
padding-top: 1rem !important;
}
}
/* Lower z-index so cookie banner appears behind onboarding modals */
#cc-main {
z-index: 100 !important;
}
+1 -1
View File
@@ -57,7 +57,7 @@ dependencies {
implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5:3.1.3.RELEASE'
api 'io.micrometer:micrometer-registry-prometheus'
implementation 'com.unboundid.product.scim2:scim2-sdk-client:4.0.0'
implementation 'com.unboundid.product.scim2:scim2-sdk-client:4.1.0'
api "io.jsonwebtoken:jjwt-api:$jwtVersion"
runtimeOnly "io.jsonwebtoken:jjwt-impl:$jwtVersion"
@@ -0,0 +1,6 @@
package stirling.software.proprietary.model;
public enum CertificateType {
AUTO_GENERATED,
USER_UPLOADED
}
@@ -0,0 +1,80 @@
package stirling.software.proprietary.model;
import java.io.Serializable;
import java.time.LocalDateTime;
import org.hibernate.annotations.CreationTimestamp;
import com.fasterxml.jackson.annotation.JsonIgnore;
import jakarta.persistence.*;
import lombok.*;
@Entity
@Table(name = "participant_certificate_submissions")
@NoArgsConstructor
@Getter
@Setter
@EqualsAndHashCode(onlyExplicitlyIncluded = true)
@ToString(onlyExplicitlyIncluded = true)
public class ParticipantCertificateSubmissionEntity implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "id")
@EqualsAndHashCode.Include
@ToString.Include
private Long id;
@OneToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "participant_id", nullable = false, unique = true)
@JsonIgnore
private SigningParticipantEntity participant;
@Column(name = "cert_type", nullable = false)
private String certType;
@Column(name = "password")
private String password;
@Lob
@Column(name = "private_key", columnDefinition = "bytea")
private byte[] privateKey;
@Lob
@Column(name = "certificate", columnDefinition = "bytea")
private byte[] certificate;
@Lob
@Column(name = "p12_keystore", columnDefinition = "bytea")
private byte[] p12Keystore;
@Lob
@Column(name = "jks_keystore", columnDefinition = "bytea")
private byte[] jksKeystore;
@Column(name = "show_signature")
private Boolean showSignature;
@Column(name = "page_number")
private Integer pageNumber;
@Column(name = "name")
private String name;
@Column(name = "reason")
private String reason;
@Column(name = "location")
private String location;
@Column(name = "show_logo")
private Boolean showLogo;
@CreationTimestamp
@Column(name = "submitted_at", updatable = false)
private LocalDateTime submittedAt;
}
@@ -0,0 +1,124 @@
package stirling.software.proprietary.model;
import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;
import org.hibernate.annotations.UpdateTimestamp;
import com.fasterxml.jackson.annotation.JsonIgnore;
import jakarta.persistence.*;
import lombok.*;
import stirling.software.common.model.api.security.ParticipantStatus;
import stirling.software.proprietary.security.model.User;
@Entity
@Table(name = "signing_participants")
@NoArgsConstructor
@Getter
@Setter
@EqualsAndHashCode(onlyExplicitlyIncluded = true)
@ToString(onlyExplicitlyIncluded = true)
public class SigningParticipantEntity implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "id")
@EqualsAndHashCode.Include
@ToString.Include
private Long id;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "session_id", nullable = false)
@JsonIgnore
private SigningSessionEntity session;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "user_id", nullable = true)
@JsonIgnore
private User user;
@Column(name = "email")
private String email;
@Column(name = "name")
private String name;
@Enumerated(EnumType.STRING)
@Column(name = "status", nullable = false)
private ParticipantStatus status = ParticipantStatus.PENDING;
@Column(name = "share_token", unique = true, length = 36)
@EqualsAndHashCode.Include
private String shareToken;
// Signature appearance settings (owner-controlled)
@Column(name = "show_signature")
private Boolean showSignature;
@Column(name = "page_number")
private Integer pageNumber;
@Column(name = "reason")
private String reason;
@Column(name = "location")
private String location;
@Column(name = "show_logo")
private Boolean showLogo;
// Wet signature metadata (visual signature placed by participant)
// This data is private to the participant and cleared after finalization
@Column(name = "wet_signature_type", length = 20)
private String wetSignatureType; // "canvas" | "image" | "text"
@Lob
@Column(name = "wet_signature_data", columnDefinition = "TEXT")
private String wetSignatureData; // Base64 image data or text
@Column(name = "wet_signature_page")
private Integer wetSignaturePage;
@Column(name = "wet_signature_x")
private Double wetSignatureX;
@Column(name = "wet_signature_y")
private Double wetSignatureY;
@Column(name = "wet_signature_width")
private Double wetSignatureWidth;
@Column(name = "wet_signature_height")
private Double wetSignatureHeight;
@ElementCollection(fetch = FetchType.LAZY)
@CollectionTable(
name = "participant_notifications",
joinColumns = @JoinColumn(name = "participant_id"))
@Column(name = "notification_message", columnDefinition = "text")
private List<String> notifications = new ArrayList<>();
@UpdateTimestamp
@Column(name = "last_updated")
private LocalDateTime lastUpdated;
@OneToOne(
mappedBy = "participant",
cascade = CascadeType.ALL,
orphanRemoval = true,
fetch = FetchType.LAZY)
@JsonIgnore
private ParticipantCertificateSubmissionEntity certificateSubmission;
public void recordNotification(String message) {
notifications.add(message);
lastUpdated = LocalDateTime.now();
}
}
@@ -0,0 +1,104 @@
package stirling.software.proprietary.model;
import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import org.hibernate.annotations.CreationTimestamp;
import org.hibernate.annotations.UpdateTimestamp;
import com.fasterxml.jackson.annotation.JsonIgnore;
import jakarta.persistence.*;
import lombok.*;
import stirling.software.proprietary.security.model.User;
@Entity
@Table(name = "signing_sessions")
@NoArgsConstructor
@Getter
@Setter
@EqualsAndHashCode(onlyExplicitlyIncluded = true)
@ToString(onlyExplicitlyIncluded = true)
public class SigningSessionEntity implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "id")
@EqualsAndHashCode.Include
@ToString.Include
private Long id;
@Column(name = "session_id", unique = true, nullable = false, length = 36)
@EqualsAndHashCode.Include
@ToString.Include
private String sessionId = UUID.randomUUID().toString();
@Column(name = "document_name", nullable = false)
private String documentName;
@Lob
@Basic(fetch = FetchType.EAGER)
@Column(name = "original_pdf", nullable = false, columnDefinition = "bytea")
@JsonIgnore
private byte[] originalPdf;
@Lob
@Basic(fetch = FetchType.EAGER)
@Column(name = "signed_pdf", columnDefinition = "bytea")
@JsonIgnore
private byte[] signedPdf;
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "user_id", nullable = false)
@JsonIgnore
private User user;
@Column(name = "owner_email")
private String ownerEmail;
@Column(name = "message", columnDefinition = "text")
private String message;
@Column(name = "due_date")
private String dueDate;
@Column(name = "is_finalized", nullable = false)
private boolean finalized = false;
@CreationTimestamp
@Column(name = "created_at", updatable = false)
private LocalDateTime createdAt;
@UpdateTimestamp
@Column(name = "updated_at")
private LocalDateTime updatedAt;
@OneToMany(
mappedBy = "session",
cascade = CascadeType.ALL,
orphanRemoval = true,
fetch = FetchType.LAZY)
@JsonIgnore
private List<SigningParticipantEntity> participants = new ArrayList<>();
public void addParticipant(SigningParticipantEntity participant) {
participants.add(participant);
participant.setSession(this);
}
public void removeParticipant(SigningParticipantEntity participant) {
participants.remove(participant);
participant.setSession(null);
}
public void touch() {
this.updatedAt = LocalDateTime.now();
}
}
@@ -0,0 +1,73 @@
package stirling.software.proprietary.model;
import java.io.Serializable;
import java.time.LocalDateTime;
import org.hibernate.annotations.CreationTimestamp;
import org.hibernate.annotations.UpdateTimestamp;
import com.fasterxml.jackson.annotation.JsonIgnore;
import jakarta.persistence.*;
import lombok.*;
import stirling.software.proprietary.security.model.User;
@Entity
@Table(name = "user_server_certificates")
@NoArgsConstructor
@Getter
@Setter
@EqualsAndHashCode(onlyExplicitlyIncluded = true)
@ToString(onlyExplicitlyIncluded = true)
public class UserServerCertificateEntity implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "id")
@EqualsAndHashCode.Include
@ToString.Include
private Long id;
@OneToOne(fetch = FetchType.LAZY)
@JoinColumn(name = "user_id", unique = true, nullable = false)
@JsonIgnore
private User user;
@Lob
@Basic(fetch = FetchType.EAGER)
@Column(name = "keystore_data", nullable = false, columnDefinition = "bytea")
@JsonIgnore
private byte[] keystoreData;
@Column(name = "keystore_password", nullable = false)
@JsonIgnore
private String keystorePassword;
@Enumerated(EnumType.STRING)
@Column(name = "certificate_type", nullable = false, length = 50)
private CertificateType certificateType;
@Column(name = "subject_dn", length = 500)
private String subjectDn;
@Column(name = "issuer_dn", length = 500)
private String issuerDn;
@Column(name = "valid_from")
private LocalDateTime validFrom;
@Column(name = "valid_to")
private LocalDateTime validTo;
@CreationTimestamp
@Column(name = "created_at", updatable = false)
private LocalDateTime createdAt;
@UpdateTimestamp
@Column(name = "updated_at")
private LocalDateTime updatedAt;
}
@@ -222,6 +222,11 @@ public class SecurityConfiguration {
request -> {
String uri = request.getRequestURI();
// Ignore CSRF for H2 console
if (uri.startsWith("/h2-console")) {
return true;
}
// Ignore CSRF for auth endpoints
if (uri.startsWith("/api/v1/auth/")) {
return true;
@@ -252,6 +257,9 @@ public class SecurityConfiguration {
.csrfTokenRequestHandler(requestHandler));
}
// Allow frames for H2 console
http.headers(headers -> headers.frameOptions(frameOptions -> frameOptions.disable()));
http.sessionManagement(
sessionManagement -> {
if (v2Enabled) {
@@ -308,7 +316,9 @@ public class SecurityConfiguration {
.alwaysRemember(false));
http.authorizeHttpRequests(
authz ->
authz.requestMatchers(
authz.requestMatchers("/h2-console/**")
.permitAll()
.requestMatchers(
req -> {
String uri = req.getRequestURI();
String contextPath = req.getContextPath();
@@ -0,0 +1,222 @@
package stirling.software.proprietary.security.controller.api;
import java.security.Principal;
import java.util.Optional;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import stirling.software.proprietary.model.UserServerCertificateEntity;
import stirling.software.proprietary.security.database.repository.UserRepository;
import stirling.software.proprietary.security.model.User;
import stirling.software.proprietary.service.UserServerCertificateService;
@RestController
@RequestMapping("/api/v1/user/certificate")
@Slf4j
@Tag(name = "User Certificate", description = "APIs for user personal certificate management")
@RequiredArgsConstructor
public class UserCertificateController {
private final UserServerCertificateService userCertificateService;
private final UserRepository userRepository;
@GetMapping("/info")
@Operation(
summary = "Get user certificate information",
description = "Returns information about the current user's personal certificate")
public ResponseEntity<CertificateInfoResponse> getUserCertificateInfo(Principal principal) {
if (principal == null) {
return ResponseEntity.status(401).build();
}
try {
User user =
userRepository
.findByUsernameIgnoreCase(principal.getName())
.orElseThrow(() -> new IllegalArgumentException("User not found"));
Optional<UserServerCertificateEntity> certOpt =
userCertificateService.getCertificateInfo(user.getId());
if (certOpt.isEmpty()) {
return ResponseEntity.ok(
new CertificateInfoResponse(
false, null, null, null, null, null, null, null));
}
UserServerCertificateEntity cert = certOpt.get();
return ResponseEntity.ok(
new CertificateInfoResponse(
true,
cert.getCertificateType().toString(),
cert.getSubjectDn(),
cert.getIssuerDn(),
cert.getValidFrom() != null ? cert.getValidFrom().toString() : null,
cert.getValidTo() != null ? cert.getValidTo().toString() : null,
cert.getCreatedAt() != null ? cert.getCreatedAt().toString() : null,
cert.getUpdatedAt() != null ? cert.getUpdatedAt().toString() : null));
} catch (Exception e) {
log.error("Failed to get user certificate info", e);
return ResponseEntity.internalServerError().build();
}
}
@PostMapping("/generate")
@Operation(
summary = "Generate new user certificate",
description = "Generate a new self-signed certificate for the current user")
public ResponseEntity<String> generateUserCertificate(Principal principal) {
if (principal == null) {
return ResponseEntity.status(401).build();
}
try {
User user =
userRepository
.findByUsernameIgnoreCase(principal.getName())
.orElseThrow(() -> new IllegalArgumentException("User not found"));
// Delete existing if any
userCertificateService.deleteUserCertificate(user.getId());
// Generate new
userCertificateService.generateUserCertificate(user);
return ResponseEntity.ok("User certificate generated successfully");
} catch (Exception e) {
log.error("Failed to generate user certificate", e);
return ResponseEntity.internalServerError()
.body("Failed to generate certificate: " + e.getMessage());
}
}
@PostMapping("/upload")
@Operation(
summary = "Upload user certificate",
description =
"Upload a custom PKCS12 certificate file to be used as the user's personal certificate")
public ResponseEntity<String> uploadUserCertificate(
Principal principal,
@Parameter(description = "PKCS12 certificate file", required = true)
@RequestParam("file")
MultipartFile file,
@Parameter(description = "Certificate password", required = true)
@RequestParam("password")
String password) {
if (principal == null) {
return ResponseEntity.status(401).build();
}
if (file.isEmpty()) {
return ResponseEntity.badRequest().body("Certificate file cannot be empty");
}
if (!file.getOriginalFilename().toLowerCase().endsWith(".p12")
&& !file.getOriginalFilename().toLowerCase().endsWith(".pfx")) {
return ResponseEntity.badRequest()
.body("Only PKCS12 (.p12 or .pfx) files are supported");
}
try {
User user =
userRepository
.findByUsernameIgnoreCase(principal.getName())
.orElseThrow(() -> new IllegalArgumentException("User not found"));
userCertificateService.uploadUserCertificate(user, file.getInputStream(), password);
return ResponseEntity.ok("User certificate uploaded successfully");
} catch (IllegalArgumentException e) {
log.warn("Invalid certificate upload: {}", e.getMessage());
return ResponseEntity.badRequest().body("Invalid certificate or password");
} catch (Exception e) {
log.error("Failed to upload user certificate", e);
return ResponseEntity.internalServerError().body("Failed to upload certificate");
}
}
@DeleteMapping
@Operation(
summary = "Delete user certificate",
description = "Delete the current user's personal certificate")
public ResponseEntity<String> deleteUserCertificate(Principal principal) {
if (principal == null) {
return ResponseEntity.status(401).build();
}
try {
User user =
userRepository
.findByUsernameIgnoreCase(principal.getName())
.orElseThrow(() -> new IllegalArgumentException("User not found"));
userCertificateService.deleteUserCertificate(user.getId());
return ResponseEntity.ok("User certificate deleted successfully");
} catch (Exception e) {
log.error("Failed to delete user certificate", e);
return ResponseEntity.internalServerError().body("Failed to delete certificate");
}
}
@GetMapping("/download")
@Operation(
summary = "Download user certificate",
description =
"Download the user's public certificate in DER format for validation purposes")
public ResponseEntity<byte[]> downloadUserCertificate(Principal principal) {
if (principal == null) {
return ResponseEntity.status(401).build();
}
try {
User user =
userRepository
.findByUsernameIgnoreCase(principal.getName())
.orElseThrow(() -> new IllegalArgumentException("User not found"));
if (!userCertificateService.hasUserCertificate(user.getId())) {
return ResponseEntity.notFound().build();
}
// Get the KeyStore and extract the public certificate
java.security.KeyStore keyStore = userCertificateService.getUserKeyStore(user.getId());
java.security.cert.X509Certificate cert =
(java.security.cert.X509Certificate)
keyStore.getCertificate(
keyStore.aliases().nextElement()); // Get first alias
byte[] certBytes = cert.getEncoded();
return ResponseEntity.ok()
.header(
HttpHeaders.CONTENT_DISPOSITION,
"attachment; filename=\"user-cert.cer\"")
.contentType(MediaType.valueOf("application/pkix-cert"))
.body(certBytes);
} catch (Exception e) {
log.error("Failed to download user certificate", e);
return ResponseEntity.internalServerError().build();
}
}
// DTO for certificate info response
public record CertificateInfoResponse(
boolean exists,
String type,
String subject,
String issuer,
String validFrom,
String validTo,
String createdAt,
String updatedAt) {}
}
@@ -27,6 +27,7 @@ import lombok.extern.slf4j.Slf4j;
import stirling.software.common.annotations.api.UserApi;
import stirling.software.common.model.ApplicationProperties;
import stirling.software.common.model.api.security.UserSummaryDTO;
import stirling.software.common.model.enumeration.Role;
import stirling.software.common.model.exception.UnsupportedProviderException;
import stirling.software.proprietary.audit.AuditEventType;
@@ -782,4 +783,34 @@ public class UserController {
.body("Failed to complete initial setup");
}
}
/**
* List all enabled users for participant selection in signing sessions
*
* @param principal The authenticated user
* @return List of user summaries
*/
@GetMapping("/users")
public ResponseEntity<List<UserSummaryDTO>> listUsers(Principal principal) {
if (principal == null) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build();
}
List<UserSummaryDTO> users =
userRepository.findAll().stream()
.filter(User::isEnabled)
.map(this::toUserSummaryDTO)
.collect(java.util.stream.Collectors.toList());
return ResponseEntity.ok(users);
}
private UserSummaryDTO toUserSummaryDTO(User user) {
return new UserSummaryDTO(
user.getId(),
user.getUsername(),
user.getUsername(), // Use username as displayName
user.getTeam() != null ? user.getTeam().getName() : null,
user.isEnabled());
}
}
@@ -72,6 +72,11 @@ public class JwtAuthenticationFilter extends OncePerRequestFilter {
filterChain.doFilter(request, response);
return;
}
// Skip H2 console
if (request.getRequestURI().startsWith("/h2-console")) {
filterChain.doFilter(request, response);
return;
}
if (!apiKeyExists(request, response)) {
String jwtToken = jwtService.extractToken(request);
@@ -28,6 +28,7 @@ import lombok.extern.slf4j.Slf4j;
import stirling.software.common.model.ApplicationProperties;
import stirling.software.common.model.ApplicationProperties.Security.OAUTH2;
import stirling.software.common.model.ApplicationProperties.Security.SAML2;
import stirling.software.common.util.RequestUriUtils;
import stirling.software.proprietary.security.model.ApiKeyAuthenticationToken;
import stirling.software.proprietary.security.model.User;
import stirling.software.proprietary.security.saml2.CustomSaml2AuthenticatedPrincipal;
@@ -110,27 +111,32 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
// If we still don't have any authentication, check if it's a public endpoint. If not, deny
// the request
if (authentication == null || !authentication.isAuthenticated()) {
String method = request.getMethod();
String contextPath = request.getContextPath();
// Allow H2 console to pass through without authentication
if (requestURI.startsWith("/h2-console")) {
filterChain.doFilter(request, response);
return;
}
// Allow public auth endpoints to pass through without authentication
if (isPublicAuthEndpoint(requestURI, contextPath)) {
filterChain.doFilter(request, response);
return;
}
if ("GET".equalsIgnoreCase(method) && !requestURI.startsWith(contextPath + "/login")) {
response.sendRedirect(contextPath + "/login"); // redirect to the login page
} else {
response.setStatus(HttpStatus.UNAUTHORIZED.value());
response.getWriter()
.write(
"""
Authentication required. Please provide a X-API-KEY in request header.
This is found in Settings -> Account Settings -> API Key
Alternatively you can disable authentication if this is unexpected.
""");
}
// For API requests, return 401 with JSON response (no redirects)
response.setStatus(HttpStatus.UNAUTHORIZED.value());
response.setContentType("application/json");
response.getWriter()
.write(
"""
{
"error": "Unauthorized",
"message": "Authentication required. Please provide valid credentials or X-API-KEY header.",
"status": 401
}
""");
return;
}
@@ -179,8 +185,18 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
// Block user registration if not allowed by configuration
if (blockRegistration && !isUserExists) {
log.warn("Blocked registration for OAuth2/SAML user: {}", username);
response.sendRedirect(
request.getContextPath() + "/logout?oAuth2AdminBlockedUser=true");
SecurityContextHolder.clearContext();
response.setStatus(HttpStatus.FORBIDDEN.value());
response.setContentType("application/json");
response.getWriter()
.write(
"""
{
"error": "Forbidden",
"message": "User registration is blocked by administrator",
"status": 403
}
""");
return;
}
@@ -194,13 +210,35 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
}
}
// Redirect to logout if credentials are invalid
// Return 401 if credentials are invalid (no redirects)
if (!isUserExists && notSsoLogin) {
response.sendRedirect(request.getContextPath() + "/logout?badCredentials=true");
SecurityContextHolder.clearContext();
response.setStatus(HttpStatus.UNAUTHORIZED.value());
response.setContentType("application/json");
response.getWriter()
.write(
"""
{
"error": "Unauthorized",
"message": "Invalid credentials",
"status": 401
}
""");
return;
}
if (isUserDisabled) {
response.sendRedirect(request.getContextPath() + "/logout?userIsDisabled=true");
SecurityContextHolder.clearContext();
response.setStatus(HttpStatus.FORBIDDEN.value());
response.setContentType("application/json");
response.getWriter()
.write(
"""
{
"error": "Forbidden",
"message": "User account is disabled",
"status": 403
}
""");
return;
}
}
@@ -250,33 +288,28 @@ public class UserAuthenticationFilter extends OncePerRequestFilter {
protected boolean shouldNotFilter(HttpServletRequest request) {
String uri = request.getRequestURI();
String contextPath = request.getContextPath();
String[] permitAllPatterns = {
contextPath + "/login",
contextPath + "/register",
contextPath + "/invite",
contextPath + "/error",
contextPath + "/images/",
contextPath + "/public/",
contextPath + "/css/",
contextPath + "/fonts/",
contextPath + "/js/",
contextPath + "/pdfjs/",
contextPath + "/pdfjs-legacy/",
// Allow unauthenticated access to static resources and SPA routes (GET/HEAD only)
if ("GET".equalsIgnoreCase(request.getMethod())
|| "HEAD".equalsIgnoreCase(request.getMethod())) {
if (RequestUriUtils.isStaticResource(contextPath, uri)
|| RequestUriUtils.isFrontendRoute(contextPath, uri)) {
return true;
}
}
// For API routes, only skip filter for these public endpoints
String[] publicApiPatterns = {
contextPath + "/api/v1/info/status",
contextPath + "/api/v1/auth/login",
contextPath + "/api/v1/auth/refresh",
contextPath + "/api/v1/auth/me",
contextPath + "/api/v1/invite/validate",
contextPath + "/api/v1/invite/accept",
contextPath + "/site.webmanifest"
contextPath + "/api/v1/invite/accept"
};
for (String pattern : permitAllPatterns) {
if (uri.startsWith(pattern)
|| uri.endsWith(".svg")
|| uri.endsWith(".mjs")
|| uri.endsWith(".png")
|| uri.endsWith(".ico")) {
for (String pattern : publicApiPatterns) {
if (uri.startsWith(pattern)) {
return true;
}
}
@@ -0,0 +1,26 @@
package stirling.software.proprietary.security.repository;
import java.util.List;
import java.util.Optional;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;
import stirling.software.proprietary.model.SigningParticipantEntity;
@Repository
public interface SigningParticipantRepository
extends JpaRepository<SigningParticipantEntity, Long> {
Optional<SigningParticipantEntity> findByShareToken(String shareToken);
@Query(
"SELECT p FROM SigningParticipantEntity p WHERE p.session.sessionId = :sessionId AND p.email = :email")
Optional<SigningParticipantEntity> findBySessionIdAndEmail(
@Param("sessionId") String sessionId, @Param("email") String email);
@Query("SELECT p FROM SigningParticipantEntity p WHERE p.session.sessionId = :sessionId")
List<SigningParticipantEntity> findAllBySessionId(@Param("sessionId") String sessionId);
}
@@ -0,0 +1,43 @@
package stirling.software.proprietary.security.repository;
import java.util.List;
import java.util.Optional;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;
import stirling.software.proprietary.model.SigningSessionEntity;
import stirling.software.proprietary.security.model.User;
@Repository
public interface SigningSessionRepository extends JpaRepository<SigningSessionEntity, Long> {
Optional<SigningSessionEntity> findBySessionId(String sessionId);
@Query(
"SELECT s FROM SigningSessionEntity s WHERE s.user.id = :userId ORDER BY s.createdAt DESC")
List<SigningSessionEntity> findAllByUserIdOrderByCreatedAtDesc(@Param("userId") Long userId);
@Query(
"SELECT s FROM SigningSessionEntity s LEFT JOIN FETCH s.participants WHERE s.sessionId = :sessionId")
Optional<SigningSessionEntity> findBySessionIdWithParticipants(
@Param("sessionId") String sessionId);
@Query(
"SELECT DISTINCT s FROM SigningSessionEntity s "
+ "LEFT JOIN FETCH s.participants p "
+ "LEFT JOIN FETCH p.certificateSubmission "
+ "WHERE s.sessionId = :sessionId")
Optional<SigningSessionEntity> findBySessionIdWithParticipantsAndCertificates(
@Param("sessionId") String sessionId);
@Query(
"SELECT s FROM SigningSessionEntity s WHERE s.user.id = :userId AND s.finalized = false ORDER BY s.createdAt DESC")
List<SigningSessionEntity> findActiveSessionsByUserId(@Param("userId") Long userId);
boolean existsBySessionId(String sessionId);
long countByUserAndFinalizedFalse(User user);
}
@@ -0,0 +1,23 @@
package stirling.software.proprietary.security.repository;
import java.util.Optional;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;
import stirling.software.proprietary.model.UserServerCertificateEntity;
@Repository
public interface UserServerCertificateRepository
extends JpaRepository<UserServerCertificateEntity, Long> {
@Query("SELECT c FROM UserServerCertificateEntity c WHERE c.user.id = :userId")
Optional<UserServerCertificateEntity> findByUserId(@Param("userId") Long userId);
@Query("SELECT c FROM UserServerCertificateEntity c WHERE c.user.username = :username")
Optional<UserServerCertificateEntity> findByUsername(@Param("username") String username);
boolean existsByUserId(Long userId);
}
@@ -0,0 +1,845 @@
package stirling.software.proprietary.security.service;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.multipart.MultipartFile;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import stirling.software.common.model.api.security.*;
import stirling.software.common.service.SigningSessionServiceInterface;
import stirling.software.common.util.ExceptionUtils;
import stirling.software.proprietary.model.ParticipantCertificateSubmissionEntity;
import stirling.software.proprietary.model.SigningParticipantEntity;
import stirling.software.proprietary.model.SigningSessionEntity;
import stirling.software.proprietary.security.database.repository.UserRepository;
import stirling.software.proprietary.security.model.User;
import stirling.software.proprietary.security.repository.SigningParticipantRepository;
import stirling.software.proprietary.security.repository.SigningSessionRepository;
@Service
@Slf4j
@RequiredArgsConstructor
public class DatabaseSigningSessionService implements SigningSessionServiceInterface {
private final SigningSessionRepository sessionRepository;
private final SigningParticipantRepository participantRepository;
private final UserService userService;
private final UserRepository userRepository;
@Override
@Transactional
public SigningSessionDetailDTO createSession(Object requestObj, String username)
throws IOException {
CreateSigningSessionRequest request = (CreateSigningSessionRequest) requestObj;
if (request.getParticipantUserIds() == null || request.getParticipantUserIds().isEmpty()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"participant user IDs");
}
User owner =
userService
.findByUsernameIgnoreCase(username)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound", "User {0} not found", username));
byte[] pdfBytes = request.getFileInput().getBytes();
log.info(
"Creating session with PDF: {} bytes from file {}",
pdfBytes != null ? pdfBytes.length : 0,
request.getFileInput().getOriginalFilename());
if (pdfBytes == null || pdfBytes.length == 0) {
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidArgument", "Uploaded PDF is null or empty");
}
SigningSessionEntity session = new SigningSessionEntity();
session.setUser(owner);
session.setDocumentName(request.getFileInput().getOriginalFilename());
session.setOwnerEmail(request.getOwnerEmail());
session.setMessage(request.getMessage());
session.setDueDate(request.getDueDate());
session.setOriginalPdf(pdfBytes);
// Add participants by user ID
for (Long userId : request.getParticipantUserIds()) {
User participantUser =
userRepository
.findById(userId)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound",
"User ID {0} not found",
userId));
SigningParticipantEntity participant = new SigningParticipantEntity();
participant.setUser(participantUser);
participant.setEmail(participantUser.getUsername()); // Keep for audit trail
participant.setName(participantUser.getUsername());
// Apply owner's signature appearance settings
participant.setShowSignature(request.getShowSignature());
participant.setPageNumber(request.getPageNumber());
participant.setReason(request.getReason());
participant.setLocation(request.getLocation());
participant.setShowLogo(request.getShowLogo());
session.addParticipant(participant);
}
if (Boolean.TRUE.equals(request.getNotifyOnCreate())) {
for (SigningParticipantEntity participant : session.getParticipants()) {
participant.recordNotification(
request.getMessage() != null
? request.getMessage()
: "You have been invited to sign a document.");
if (participant.getStatus() == ParticipantStatus.PENDING) {
participant.setStatus(ParticipantStatus.NOTIFIED);
}
}
}
session = sessionRepository.save(session);
return toDetailDTO(session);
}
@Override
@Transactional(readOnly = true)
public List<SigningSessionSummaryDTO> listUserSessions(String username) {
User user =
userService
.findByUsernameIgnoreCase(username)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound", "User {0} not found", username));
List<SigningSessionEntity> sessions =
sessionRepository.findAllByUserIdOrderByCreatedAtDesc(user.getId());
return sessions.stream().map(this::toSummaryDTO).collect(Collectors.toList());
}
@Override
@Transactional(readOnly = true)
public SigningSessionDetailDTO getSessionDetail(String sessionId, String username) {
SigningSessionEntity session = getSessionEntityByIdWithOwnershipCheck(sessionId, username);
return toDetailDTO(session);
}
@Transactional(readOnly = true)
public SigningSession getSession(String sessionId) {
// Use query with participants and certificates fetch for finalization
SigningSessionEntity entity =
sessionRepository
.findBySessionIdWithParticipantsAndCertificates(sessionId)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound",
"Signing session {0} was not found",
sessionId));
// Force LOB loading within transaction
byte[] originalPdf = entity.getOriginalPdf();
byte[] signedPdf = entity.getSignedPdf();
log.debug(
"Loading session {} for signing: originalPdf={} bytes, signedPdf={} bytes, participants={}",
sessionId,
originalPdf != null ? originalPdf.length : 0,
signedPdf != null ? signedPdf.length : 0,
entity.getParticipants().size());
if (originalPdf == null || originalPdf.length == 0) {
log.error("Original PDF is null or empty for session {}", sessionId);
throw ExceptionUtils.createIllegalArgumentException(
"error.notFound", "Original PDF not found for session {0}", sessionId);
}
return toSigningSession(entity);
}
public SigningSessionEntity getSessionEntityById(String sessionId) {
return sessionRepository
.findBySessionIdWithParticipants(sessionId)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound",
"Signing session {0} was not found",
sessionId));
}
private SigningSessionEntity getSessionEntityByIdWithOwnershipCheck(
String sessionId, String username) {
SigningSessionEntity session = getSessionEntityById(sessionId);
validateSessionOwnership(session, username);
return session;
}
@Override
@Transactional
public void deleteSession(String sessionId, String username) {
SigningSessionEntity session = getSessionEntityByIdWithOwnershipCheck(sessionId, username);
if (session.isFinalized()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidArgument", "Cannot delete finalized session", sessionId);
}
sessionRepository.delete(session);
}
@Override
@Transactional
public SigningSessionDetailDTO addParticipants(
String sessionId, Object requestObj, String username) {
AddParticipantsRequest request = (AddParticipantsRequest) requestObj;
if (request.getParticipantUserIds() == null || request.getParticipantUserIds().isEmpty()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.optionsNotSpecified",
"{0} options are not specified",
"participant user IDs");
}
SigningSessionEntity session = getSessionEntityByIdWithOwnershipCheck(sessionId, username);
// Add participants by user ID
for (Long userId : request.getParticipantUserIds()) {
User participantUser =
userRepository
.findById(userId)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound",
"User ID {0} not found",
userId));
SigningParticipantEntity participant = new SigningParticipantEntity();
participant.setUser(participantUser);
participant.setEmail(participantUser.getUsername()); // Keep for audit trail
participant.setName(participantUser.getUsername());
// Copy signature settings from existing participants (or use defaults)
SigningParticipantEntity firstParticipant =
session.getParticipants().isEmpty() ? null : session.getParticipants().get(0);
if (firstParticipant != null) {
participant.setShowSignature(firstParticipant.getShowSignature());
participant.setPageNumber(firstParticipant.getPageNumber());
participant.setReason(firstParticipant.getReason());
participant.setLocation(firstParticipant.getLocation());
participant.setShowLogo(firstParticipant.getShowLogo());
}
session.addParticipant(participant);
}
session = sessionRepository.save(session);
return toDetailDTO(session);
}
@Override
@Transactional
public void removeParticipant(String sessionId, Long userId, String username) {
SigningSessionEntity session = getSessionEntityByIdWithOwnershipCheck(sessionId, username);
SigningParticipantEntity participant =
session.getParticipants().stream()
.filter(p -> p.getUser().getId().equals(userId))
.findFirst()
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound",
"Participant with user ID {0} not found",
userId));
if (participant.getStatus() == ParticipantStatus.SIGNED) {
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidArgument",
"Cannot remove participant who has already signed",
userId);
}
session.removeParticipant(participant);
sessionRepository.save(session);
}
@Override
@Transactional
public SigningSession notifyParticipants(String sessionId, Object requestObj) {
NotifySigningParticipantsRequest request = (NotifySigningParticipantsRequest) requestObj;
SigningSessionEntity session = getSessionEntityById(sessionId);
List<SigningParticipantEntity> targets =
getTargetParticipants(session, request.getParticipantEmails());
String message =
StringUtils.defaultIfBlank(
request.getMessage(), "A reminder to review and sign the document.");
for (SigningParticipantEntity participant : targets) {
participant.recordNotification(message);
if (participant.getStatus() == ParticipantStatus.PENDING) {
participant.setStatus(ParticipantStatus.NOTIFIED);
}
}
session.touch();
session = sessionRepository.save(session);
return toSigningSession(session);
}
@Override
@Transactional
public SigningSession attachCertificate(String sessionId, Long userId, Object requestObj)
throws IOException {
ParticipantCertificateRequest request = (ParticipantCertificateRequest) requestObj;
SigningSessionEntity session = getSessionEntityById(sessionId);
SigningParticipantEntity participant =
session.getParticipants().stream()
.filter(p -> p.getUser().getId().equals(userId))
.findFirst()
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound",
"Participant with user ID {0} does not exist",
userId));
ParticipantCertificateSubmissionEntity submissionEntity =
toSubmissionEntity(request, participant);
participant.setCertificateSubmission(submissionEntity);
participant.setStatus(ParticipantStatus.SIGNED);
session.touch();
session = sessionRepository.save(session);
return toSigningSession(session);
}
@Override
@Transactional
public void markSessionFinalized(String sessionId, byte[] signedPdf) {
if (signedPdf == null || signedPdf.length == 0) {
log.error("Attempting to save null or empty signed PDF for session {}", sessionId);
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidArgument", "Signed PDF cannot be null or empty", sessionId);
}
SigningSessionEntity session =
sessionRepository
.findBySessionId(sessionId)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound",
"Signing session {0} was not found",
sessionId));
log.info(
"Saving signed PDF for session {}: {} bytes",
sessionId,
signedPdf != null ? signedPdf.length : 0);
session.setSignedPdf(signedPdf);
session.setFinalized(true);
sessionRepository.saveAndFlush(session);
log.info("Signed PDF saved successfully for session {}", sessionId);
}
@Override
@Transactional(readOnly = true)
public byte[] getSessionPdf(String sessionId, String username) {
SigningSessionEntity session = getSessionEntityById(sessionId);
// Validate user is a participant in this session
boolean isParticipant =
session.getParticipants().stream()
.anyMatch(p -> p.getUser().getUsername().equalsIgnoreCase(username));
if (!isParticipant) {
throw ExceptionUtils.createIllegalArgumentException(
"error.unauthorized",
"User {0} is not a participant in session {1}",
username,
sessionId);
}
return session.getOriginalPdf();
}
@Override
@Transactional(readOnly = true)
public byte[] getSignedPdf(String sessionId, String username) {
// Use simple query to fetch session without joins for better LOB loading
SigningSessionEntity session =
sessionRepository
.findBySessionId(sessionId)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound",
"Signing session {0} was not found",
sessionId));
validateSessionOwnership(session, username);
if (!session.isFinalized()) {
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidState", "Session is not finalized", sessionId);
}
byte[] signedPdf = session.getSignedPdf();
if (signedPdf == null || signedPdf.length == 0) {
log.error("Signed PDF is null or empty for session {}", sessionId);
throw ExceptionUtils.createIllegalArgumentException(
"error.notFound", "Signed PDF not found for session {0}", sessionId);
}
return signedPdf;
}
@Override
@Transactional(readOnly = true)
public List<SignRequestSummaryDTO> listSignRequests(String username) {
User user =
userService
.findByUsernameIgnoreCase(username)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound", "User {0} not found", username));
// Find all sessions where user is a participant
List<SigningSessionEntity> sessions =
sessionRepository.findAll().stream()
.filter(
session ->
session.getParticipants().stream()
.anyMatch(
p ->
p.getUser()
.getId()
.equals(user.getId())))
.sorted((a, b) -> b.getCreatedAt().compareTo(a.getCreatedAt()))
.collect(Collectors.toList());
return sessions.stream()
.map(session -> toSignRequestSummaryDTO(session, user.getId()))
.collect(Collectors.toList());
}
@Override
@Transactional(readOnly = true)
public SignRequestDetailDTO getSignRequestDetail(String sessionId, String username) {
SigningSessionEntity session = getSessionEntityById(sessionId);
User user =
userService
.findByUsernameIgnoreCase(username)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound", "User {0} not found", username));
// Find participant matching user
SigningParticipantEntity participant =
session.getParticipants().stream()
.filter(p -> p.getUser().getId().equals(user.getId()))
.findFirst()
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.unauthorized",
"User {0} is not a participant in session {1}",
username,
sessionId));
String ownerUsername =
session.getUser() != null
? session.getUser().getUsername()
: session.getOwnerEmail();
return new SignRequestDetailDTO(
session.getSessionId(),
session.getDocumentName(),
ownerUsername,
session.getMessage(),
session.getDueDate(),
session.getCreatedAt().toString(),
participant.getStatus(),
participant.getShowSignature(),
participant.getPageNumber(),
participant.getReason(),
participant.getLocation(),
participant.getShowLogo());
}
@Override
@Transactional
public void declineSignRequest(String sessionId, String username) {
SigningSessionEntity session = getSessionEntityById(sessionId);
User user =
userService
.findByUsernameIgnoreCase(username)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound", "User {0} not found", username));
// Find participant matching user
SigningParticipantEntity participant =
session.getParticipants().stream()
.filter(p -> p.getUser().getId().equals(user.getId()))
.findFirst()
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.unauthorized",
"User {0} is not a participant in session {1}",
username,
sessionId));
if (participant.getStatus() == ParticipantStatus.SIGNED) {
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidState",
"Cannot decline - participant has already signed",
sessionId);
}
participant.setStatus(ParticipantStatus.DECLINED);
session.touch();
sessionRepository.save(session);
}
@Override
@Transactional
public void signDocument(String sessionId, String username, Object request) throws IOException {
if (!(request instanceof SignDocumentRequest)) {
throw new IllegalArgumentException("Invalid request type");
}
SignDocumentRequest signRequest = (SignDocumentRequest) request;
SigningSessionEntity session = getSessionEntityById(sessionId);
User user =
userService
.findByUsernameIgnoreCase(username)
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.notFound", "User {0} not found", username));
// Find participant matching user
SigningParticipantEntity participant =
session.getParticipants().stream()
.filter(p -> p.getUser().getId().equals(user.getId()))
.findFirst()
.orElseThrow(
() ->
ExceptionUtils.createIllegalArgumentException(
"error.unauthorized",
"User {0} is not a participant in session {1}",
username,
sessionId));
if (participant.getStatus() == ParticipantStatus.SIGNED) {
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidState", "Participant has already signed", sessionId);
}
if (participant.getStatus() == ParticipantStatus.DECLINED) {
throw ExceptionUtils.createIllegalArgumentException(
"error.invalidState", "Cannot sign - participant has declined", sessionId);
}
// Store wet signature metadata if provided
if (signRequest.hasWetSignature()) {
WetSignatureMetadata wetSig = signRequest.extractWetSignatureMetadata();
participant.setWetSignatureType(wetSig.getType());
participant.setWetSignatureData(wetSig.getData());
participant.setWetSignaturePage(wetSig.getPage());
participant.setWetSignatureX(wetSig.getX());
participant.setWetSignatureY(wetSig.getY());
participant.setWetSignatureWidth(wetSig.getWidth());
participant.setWetSignatureHeight(wetSig.getHeight());
}
// Store certificate data (reuse existing attachCertificate logic)
ParticipantCertificateRequest certRequest = new ParticipantCertificateRequest();
certRequest.setCertType(signRequest.getCertType());
certRequest.setPassword(signRequest.getPassword());
certRequest.setP12File(signRequest.getP12File());
certRequest.setPrivateKeyFile(signRequest.getPrivateKeyFile());
certRequest.setCertFile(signRequest.getCertFile());
// Use participant's signature settings from session
certRequest.setShowSignature(participant.getShowSignature());
certRequest.setPageNumber(participant.getPageNumber());
certRequest.setReason(participant.getReason());
certRequest.setLocation(participant.getLocation());
certRequest.setShowLogo(participant.getShowLogo());
// Store certificate submission (same as attachCertificate method)
ParticipantCertificateSubmissionEntity submissionEntity =
toSubmissionEntity(certRequest, participant);
participant.setCertificateSubmission(submissionEntity);
// Mark as signed
participant.setStatus(ParticipantStatus.SIGNED);
session.touch();
sessionRepository.save(session);
}
private void validateSessionOwnership(SigningSessionEntity session, String username) {
if (!session.getUser().getUsername().equalsIgnoreCase(username)) {
throw ExceptionUtils.createIllegalArgumentException(
"error.unauthorized", "You do not have permission to access this session");
}
}
private List<SigningParticipantEntity> getTargetParticipants(
SigningSessionEntity session, List<String> requestedEmails) {
if (requestedEmails == null || requestedEmails.isEmpty()) {
return session.getParticipants();
}
return session.getParticipants().stream()
.filter(p -> requestedEmails.contains(p.getEmail()))
.collect(Collectors.toList());
}
private ParticipantCertificateSubmissionEntity toSubmissionEntity(
ParticipantCertificateRequest request, SigningParticipantEntity participant)
throws IOException {
ParticipantCertificateSubmissionEntity entity =
new ParticipantCertificateSubmissionEntity();
entity.setParticipant(participant);
entity.setCertType(request.getCertType());
entity.setPassword(request.getPassword());
entity.setPrivateKey(toBytes(request.getPrivateKeyFile()));
entity.setCertificate(toBytes(request.getCertFile()));
entity.setP12Keystore(toBytes(request.getP12File()));
entity.setJksKeystore(toBytes(request.getJksFile()));
// Copy signature appearance settings from participant (configured by owner)
entity.setShowSignature(participant.getShowSignature());
entity.setPageNumber(participant.getPageNumber());
entity.setName(participant.getName());
entity.setReason(participant.getReason());
entity.setLocation(participant.getLocation());
entity.setShowLogo(participant.getShowLogo());
return entity;
}
private byte[] toBytes(MultipartFile file) throws IOException {
if (file == null || file.isEmpty()) {
return null;
}
return file.getBytes();
}
private SigningSessionSummaryDTO toSummaryDTO(SigningSessionEntity entity) {
int participantCount = entity.getParticipants().size();
int signedCount =
(int)
entity.getParticipants().stream()
.filter(p -> p.getStatus() == ParticipantStatus.SIGNED)
.count();
return new SigningSessionSummaryDTO(
entity.getSessionId(),
entity.getDocumentName(),
entity.getCreatedAt(),
participantCount,
signedCount,
entity.isFinalized());
}
private SignRequestSummaryDTO toSignRequestSummaryDTO(
SigningSessionEntity entity, Long userId) {
// Find participant matching user to get their status
SigningParticipantEntity participant =
entity.getParticipants().stream()
.filter(p -> p.getUser().getId().equals(userId))
.findFirst()
.orElse(null);
ParticipantStatus myStatus =
participant != null ? participant.getStatus() : ParticipantStatus.PENDING;
String ownerUsername =
entity.getUser() != null ? entity.getUser().getUsername() : entity.getOwnerEmail();
return new SignRequestSummaryDTO(
entity.getSessionId(),
entity.getDocumentName(),
ownerUsername,
entity.getCreatedAt().toString(),
entity.getDueDate(),
myStatus);
}
private SigningSessionDetailDTO toDetailDTO(SigningSessionEntity entity) {
List<ParticipantDTO> participants =
entity.getParticipants().stream()
.map(this::toParticipantDTO)
.collect(Collectors.toList());
return new SigningSessionDetailDTO(
entity.getSessionId(),
entity.getDocumentName(),
entity.getOwnerEmail(),
entity.getMessage(),
entity.getDueDate(),
entity.getCreatedAt(),
entity.getUpdatedAt(),
entity.isFinalized(),
participants);
}
private ParticipantDTO toParticipantDTO(SigningParticipantEntity entity) {
User user = entity.getUser();
return new ParticipantDTO(
user.getId(),
user.getUsername(),
entity.getName() != null ? entity.getName() : user.getUsername(),
entity.getStatus(),
entity.getLastUpdated(),
entity.getShowSignature(),
entity.getPageNumber(),
entity.getReason(),
entity.getLocation(),
entity.getShowLogo());
}
private SigningSession toSigningSession(SigningSessionEntity entity) {
SigningSession session = new SigningSession();
session.setSessionId(entity.getSessionId());
session.setDocumentName(entity.getDocumentName());
session.setOriginalPdf(entity.getOriginalPdf());
session.setSignedPdf(entity.getSignedPdf());
session.setOwnerEmail(entity.getOwnerEmail());
session.setMessage(entity.getMessage());
session.setDueDate(entity.getDueDate());
session.setCreatedAt(entity.getCreatedAt().toString());
session.setUpdatedAt(entity.getUpdatedAt().toString());
List<SigningParticipant> participants =
entity.getParticipants().stream()
.map(this::toSigningParticipant)
.collect(Collectors.toList());
session.setParticipants(participants);
return session;
}
private SigningParticipant toSigningParticipant(SigningParticipantEntity entity) {
SigningParticipant participant = new SigningParticipant();
participant.setUserId(entity.getUser() != null ? entity.getUser().getId() : null);
participant.setEmail(entity.getEmail());
participant.setName(entity.getName());
participant.setStatus(entity.getStatus());
participant.setShareToken(entity.getShareToken());
// Force lazy collection to load by creating a new ArrayList
participant.setNotifications(new ArrayList<>(entity.getNotifications()));
participant.setLastUpdated(entity.getLastUpdated().toString());
if (entity.getCertificateSubmission() != null) {
participant.setCertificateSubmission(
toParticipantCertificateSubmission(entity.getCertificateSubmission()));
}
return participant;
}
private ParticipantCertificateSubmission toParticipantCertificateSubmission(
ParticipantCertificateSubmissionEntity entity) {
return ParticipantCertificateSubmission.builder()
.certType(entity.getCertType())
.password(entity.getPassword())
.privateKey(entity.getPrivateKey())
.certificate(entity.getCertificate())
.p12Keystore(entity.getP12Keystore())
.jksKeystore(entity.getJksKeystore())
.showSignature(entity.getShowSignature())
.pageNumber(entity.getPageNumber())
.name(entity.getName())
.reason(entity.getReason())
.location(entity.getLocation())
.showLogo(entity.getShowLogo())
.build();
}
/**
* Gets all wet signature metadata for participants who have signed. Used during finalization to
* overlay wet signatures on the PDF.
*
* @param sessionId The session ID
* @return List of wet signature metadata for all signed participants
*/
public List<WetSignatureMetadata> getAllWetSignatures(String sessionId) {
SigningSessionEntity session = getSessionEntityById(sessionId);
return session.getParticipants().stream()
.filter(p -> p.getStatus() == ParticipantStatus.SIGNED)
.filter(p -> p.getWetSignatureType() != null)
.map(
p -> {
WetSignatureMetadata meta = new WetSignatureMetadata();
meta.setType(p.getWetSignatureType());
meta.setData(p.getWetSignatureData());
meta.setPage(p.getWetSignaturePage());
meta.setX(p.getWetSignatureX());
meta.setY(p.getWetSignatureY());
meta.setWidth(p.getWetSignatureWidth());
meta.setHeight(p.getWetSignatureHeight());
return meta;
})
.collect(Collectors.toList());
}
/**
* Clears wet signature metadata from all participants after finalization. This is required for
* GDPR compliance and to avoid storing large base64 data.
*
* @param sessionId The session ID
*/
@Transactional
public void clearWetSignatureMetadata(String sessionId) {
SigningSessionEntity session = getSessionEntityById(sessionId);
boolean anyCleared = false;
for (SigningParticipantEntity participant : session.getParticipants()) {
if (participant.getWetSignatureType() != null) {
participant.setWetSignatureType(null);
participant.setWetSignatureData(null);
participant.setWetSignaturePage(null);
participant.setWetSignatureX(null);
participant.setWetSignatureY(null);
participant.setWetSignatureWidth(null);
participant.setWetSignatureHeight(null);
anyCleared = true;
}
}
if (anyCleared) {
log.info("Cleared wet signature metadata for session: {}", sessionId);
sessionRepository.save(session);
}
}
@Override
public boolean isDatabaseBacked() {
return true;
}
}
@@ -0,0 +1,251 @@
package stirling.software.proprietary.service;
import java.io.*;
import java.math.BigInteger;
import java.security.*;
import java.security.cert.Certificate;
import java.security.cert.X509Certificate;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.Date;
import java.util.Optional;
import org.bouncycastle.asn1.x500.X500Name;
import org.bouncycastle.asn1.x509.BasicConstraints;
import org.bouncycastle.asn1.x509.ExtendedKeyUsage;
import org.bouncycastle.asn1.x509.Extension;
import org.bouncycastle.asn1.x509.KeyPurposeId;
import org.bouncycastle.asn1.x509.KeyUsage;
import org.bouncycastle.cert.X509CertificateHolder;
import org.bouncycastle.cert.jcajce.JcaX509CertificateConverter;
import org.bouncycastle.cert.jcajce.JcaX509ExtensionUtils;
import org.bouncycastle.cert.jcajce.JcaX509v3CertificateBuilder;
import org.bouncycastle.jce.provider.BouncyCastleProvider;
import org.bouncycastle.operator.ContentSigner;
import org.bouncycastle.operator.jcajce.JcaContentSignerBuilder;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import stirling.software.proprietary.model.CertificateType;
import stirling.software.proprietary.model.UserServerCertificateEntity;
import stirling.software.proprietary.security.database.repository.UserRepository;
import stirling.software.proprietary.security.model.User;
import stirling.software.proprietary.security.repository.UserServerCertificateRepository;
@Service
@Slf4j
@RequiredArgsConstructor
public class UserServerCertificateService {
private static final String KEYSTORE_ALIAS = "stirling-pdf-user-cert";
private static final String DEFAULT_PASSWORD_PREFIX = "stirling-user-cert-";
private static final int VALIDITY_DAYS = 365;
private final UserServerCertificateRepository certificateRepository;
private final UserRepository userRepository;
static {
Security.addProvider(new BouncyCastleProvider());
}
/** Get or create user certificate (auto-generate if not exists) */
@Transactional
public UserServerCertificateEntity getOrCreateUserCertificate(Long userId) throws Exception {
Optional<UserServerCertificateEntity> existing = certificateRepository.findByUserId(userId);
if (existing.isPresent()) {
return existing.get();
}
User user =
userRepository
.findById(userId)
.orElseThrow(() -> new IllegalArgumentException("User not found"));
return generateUserCertificate(user);
}
/** Generate new certificate for user */
@Transactional
public UserServerCertificateEntity generateUserCertificate(User user) throws Exception {
log.info("Generating server certificate for user: {}", user.getUsername());
// Generate key pair
KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance("RSA", "BC");
keyPairGenerator.initialize(2048, new SecureRandom());
KeyPair keyPair = keyPairGenerator.generateKeyPair();
// Certificate details with username
String username = user.getUsername();
X500Name subject = new X500Name("CN=" + username + ", O=Stirling-PDF User, C=US");
BigInteger serialNumber = BigInteger.valueOf(System.currentTimeMillis());
Date notBefore = new Date();
Date notAfter =
new Date(notBefore.getTime() + ((long) VALIDITY_DAYS * 24 * 60 * 60 * 1000));
// Build certificate
JcaX509v3CertificateBuilder certBuilder =
new JcaX509v3CertificateBuilder(
subject, serialNumber, notBefore, notAfter, subject, keyPair.getPublic());
// Add PDF-specific certificate extensions
JcaX509ExtensionUtils extUtils = new JcaX509ExtensionUtils();
// End-entity certificate, not a CA
certBuilder.addExtension(Extension.basicConstraints, true, new BasicConstraints(false));
// Key usage for PDF digital signatures
certBuilder.addExtension(
Extension.keyUsage,
true,
new KeyUsage(KeyUsage.digitalSignature | KeyUsage.nonRepudiation));
// Extended key usage for document signing
certBuilder.addExtension(
Extension.extendedKeyUsage,
false,
new ExtendedKeyUsage(KeyPurposeId.id_kp_codeSigning));
// Subject Key Identifier
certBuilder.addExtension(
Extension.subjectKeyIdentifier,
false,
extUtils.createSubjectKeyIdentifier(keyPair.getPublic()));
// Authority Key Identifier for self-signed cert
certBuilder.addExtension(
Extension.authorityKeyIdentifier,
false,
extUtils.createAuthorityKeyIdentifier(keyPair.getPublic()));
// Sign certificate
ContentSigner signer =
new JcaContentSignerBuilder("SHA256WithRSA")
.setProvider("BC")
.build(keyPair.getPrivate());
X509CertificateHolder certHolder = certBuilder.build(signer);
X509Certificate cert =
new JcaX509CertificateConverter().setProvider("BC").getCertificate(certHolder);
// Create keystore
KeyStore keyStore = KeyStore.getInstance("PKCS12");
keyStore.load(null, null);
String password = generateUserPassword(user.getId());
keyStore.setKeyEntry(
KEYSTORE_ALIAS,
keyPair.getPrivate(),
password.toCharArray(),
new Certificate[] {cert});
// Store keystore bytes
ByteArrayOutputStream baos = new ByteArrayOutputStream();
keyStore.store(baos, password.toCharArray());
byte[] keystoreBytes = baos.toByteArray();
// Create entity
UserServerCertificateEntity entity = new UserServerCertificateEntity();
entity.setUser(user);
entity.setKeystoreData(keystoreBytes);
entity.setKeystorePassword(password);
entity.setCertificateType(CertificateType.AUTO_GENERATED);
entity.setSubjectDn(cert.getSubjectX500Principal().getName());
entity.setIssuerDn(cert.getIssuerX500Principal().getName());
entity.setValidFrom(
LocalDateTime.ofInstant(cert.getNotBefore().toInstant(), ZoneId.systemDefault()));
entity.setValidTo(
LocalDateTime.ofInstant(cert.getNotAfter().toInstant(), ZoneId.systemDefault()));
return certificateRepository.save(entity);
}
/** Upload user-provided certificate */
@Transactional
public UserServerCertificateEntity uploadUserCertificate(
User user, InputStream p12Stream, String password) throws Exception {
log.info("Uploading user certificate for user: {}", user.getUsername());
// Validate keystore
byte[] keystoreBytes = p12Stream.readAllBytes();
KeyStore keyStore = KeyStore.getInstance("PKCS12");
keyStore.load(new ByteArrayInputStream(keystoreBytes), password.toCharArray());
// Extract certificate info
String alias = keyStore.aliases().nextElement();
X509Certificate cert = (X509Certificate) keyStore.getCertificate(alias);
if (cert == null) {
throw new IllegalArgumentException("No certificate found in keystore");
}
// Create or update entity
UserServerCertificateEntity entity =
certificateRepository
.findByUserId(user.getId())
.orElse(new UserServerCertificateEntity());
entity.setUser(user);
entity.setKeystoreData(keystoreBytes);
entity.setKeystorePassword(password);
entity.setCertificateType(CertificateType.USER_UPLOADED);
entity.setSubjectDn(cert.getSubjectX500Principal().getName());
entity.setIssuerDn(cert.getIssuerX500Principal().getName());
entity.setValidFrom(
LocalDateTime.ofInstant(cert.getNotBefore().toInstant(), ZoneId.systemDefault()));
entity.setValidTo(
LocalDateTime.ofInstant(cert.getNotAfter().toInstant(), ZoneId.systemDefault()));
return certificateRepository.save(entity);
}
/** Get user's KeyStore for signing operations */
@Transactional(readOnly = true)
public KeyStore getUserKeyStore(Long userId) throws Exception {
UserServerCertificateEntity cert =
certificateRepository
.findByUserId(userId)
.orElseThrow(
() -> new IllegalArgumentException("User certificate not found"));
KeyStore keyStore = KeyStore.getInstance("PKCS12");
keyStore.load(
new ByteArrayInputStream(cert.getKeystoreData()),
cert.getKeystorePassword().toCharArray());
return keyStore;
}
/** Get user's keystore password */
@Transactional(readOnly = true)
public String getUserKeystorePassword(Long userId) {
UserServerCertificateEntity cert =
certificateRepository
.findByUserId(userId)
.orElseThrow(
() -> new IllegalArgumentException("User certificate not found"));
return cert.getKeystorePassword();
}
/** Delete user certificate */
@Transactional
public void deleteUserCertificate(Long userId) {
certificateRepository.findByUserId(userId).ifPresent(certificateRepository::delete);
}
/** Check if user has certificate */
@Transactional(readOnly = true)
public boolean hasUserCertificate(Long userId) {
return certificateRepository.findByUserId(userId).isPresent();
}
/** Get certificate info (without keystore data) */
@Transactional(readOnly = true)
public Optional<UserServerCertificateEntity> getCertificateInfo(Long userId) {
return certificateRepository.findByUserId(userId);
}
/** Generate consistent password for user (based on user ID) */
private String generateUserPassword(Long userId) {
return DEFAULT_PASSWORD_PREFIX + userId;
}
}
@@ -0,0 +1,87 @@
-- Migration: Convert shared signing from email-based to user-based participants
-- Date: 2025-12-03
-- Description: Add User FK to signing_participants, signature appearance fields,
-- and create user_server_certificates table
-- ===========================================================================
-- PART 1: Add new columns to signing_participants table
-- ===========================================================================
-- Add user_id FK column (nullable initially for migration)
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS user_id BIGINT;
-- Make existing email field nullable (keep for audit trail)
ALTER TABLE signing_participants ALTER COLUMN email DROP NOT NULL;
-- Make share_token nullable (deprecating this field)
ALTER TABLE signing_participants ALTER COLUMN share_token DROP NOT NULL;
-- Add signature appearance columns (owner-controlled)
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS show_signature BOOLEAN;
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS page_number INTEGER;
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS reason VARCHAR(255);
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS location VARCHAR(255);
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS show_logo BOOLEAN;
-- ===========================================================================
-- PART 2: Migrate existing data
-- ===========================================================================
-- Match existing participants to users based on email = username
-- NOTE: This assumes participants were created with email matching username
UPDATE signing_participants sp
SET user_id = u.user_id
FROM users u
WHERE sp.email = u.username
AND sp.user_id IS NULL;
-- ===========================================================================
-- PART 3: Add constraints
-- ===========================================================================
-- Add Foreign Key constraint to User table
ALTER TABLE signing_participants
ADD CONSTRAINT fk_participant_user
FOREIGN KEY (user_id) REFERENCES users(user_id)
ON DELETE CASCADE;
-- Make user_id non-nullable after migration
ALTER TABLE signing_participants ALTER COLUMN user_id SET NOT NULL;
-- ===========================================================================
-- PART 4: Create user_server_certificates table
-- ===========================================================================
CREATE TABLE IF NOT EXISTS user_server_certificates (
id BIGSERIAL PRIMARY KEY,
user_id BIGINT NOT NULL UNIQUE,
keystore_data BYTEA NOT NULL,
keystore_password VARCHAR(255) NOT NULL,
certificate_type VARCHAR(50) NOT NULL,
subject_dn VARCHAR(500),
issuer_dn VARCHAR(500),
valid_from TIMESTAMP,
valid_to TIMESTAMP,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT fk_user_cert_user FOREIGN KEY (user_id) REFERENCES users(user_id) ON DELETE CASCADE
);
-- Create index on user_id for faster lookups
CREATE INDEX IF NOT EXISTS idx_user_cert_user_id ON user_server_certificates(user_id);
-- ===========================================================================
-- VERIFICATION QUERIES (Run these to verify migration)
-- ===========================================================================
-- Check participants without user mapping
-- SELECT * FROM signing_participants WHERE user_id IS NULL;
-- Check new table structure
-- SELECT column_name, data_type, is_nullable
-- FROM information_schema.columns
-- WHERE table_name = 'signing_participants'
-- ORDER BY ordinal_position;
-- Check user certificates table
-- SELECT * FROM user_server_certificates;
@@ -0,0 +1,74 @@
-- Migration: Add wet signature metadata fields to signing_participants
-- Date: 2025-01-15
-- Description: Add columns to store visual signature annotations placed by participants.
-- This metadata is used to overlay wet signatures on the PDF during finalization
-- and is cleared after the final signed PDF is generated.
-- ===========================================================================
-- Add wet signature metadata columns
-- ===========================================================================
-- Type of wet signature: "canvas" (drawn), "image" (uploaded), "text" (typed)
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS wet_signature_type VARCHAR(20);
-- Base64-encoded image data or text content
-- Using TEXT for large base64 image data
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS wet_signature_data TEXT;
-- Position and size of the signature on the PDF
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS wet_signature_page INTEGER;
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS wet_signature_x DOUBLE PRECISION;
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS wet_signature_y DOUBLE PRECISION;
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS wet_signature_width DOUBLE PRECISION;
ALTER TABLE signing_participants ADD COLUMN IF NOT EXISTS wet_signature_height DOUBLE PRECISION;
-- ===========================================================================
-- Add indexes for common queries
-- ===========================================================================
-- Index for querying participants with wet signatures during finalization
CREATE INDEX IF NOT EXISTS idx_participants_wet_signature
ON signing_participants(session_id, wet_signature_type)
WHERE wet_signature_type IS NOT NULL;
-- ===========================================================================
-- Add comments for documentation
-- ===========================================================================
COMMENT ON COLUMN signing_participants.wet_signature_type IS
'Type of wet signature: canvas, image, or text. NULL if participant has not placed a visual signature.';
COMMENT ON COLUMN signing_participants.wet_signature_data IS
'Base64-encoded image data or text content for the wet signature. Cleared after finalization for GDPR compliance.';
COMMENT ON COLUMN signing_participants.wet_signature_page IS
'Zero-indexed page number where the wet signature is placed.';
COMMENT ON COLUMN signing_participants.wet_signature_x IS
'X coordinate (in PDF points) of the signature rectangle, measured from left edge.';
COMMENT ON COLUMN signing_participants.wet_signature_y IS
'Y coordinate (in PDF points) of the signature rectangle, measured from top edge (UI coordinates, will be converted for PDF).';
COMMENT ON COLUMN signing_participants.wet_signature_width IS
'Width of the signature rectangle in PDF points.';
COMMENT ON COLUMN signing_participants.wet_signature_height IS
'Height of the signature rectangle in PDF points.';
-- ===========================================================================
-- VERIFICATION QUERIES (Run these to verify migration)
-- ===========================================================================
-- Check new column structure
-- SELECT column_name, data_type, is_nullable, column_default
-- FROM information_schema.columns
-- WHERE table_name = 'signing_participants'
-- AND column_name LIKE 'wet_signature%'
-- ORDER BY ordinal_position;
-- Check index creation
-- SELECT indexname, indexdef
-- FROM pg_indexes
-- WHERE tablename = 'signing_participants'
-- AND indexname LIKE '%wet_signature%';
@@ -0,0 +1,21 @@
-- Create user_server_certificates table for storing per-user signing certificates
CREATE TABLE IF NOT EXISTS user_server_certificates (
id BIGSERIAL PRIMARY KEY,
user_id BIGINT NOT NULL UNIQUE,
keystore_data BYTEA NOT NULL,
keystore_password VARCHAR(255) NOT NULL,
certificate_type VARCHAR(50) NOT NULL,
subject_dn VARCHAR(500),
issuer_dn VARCHAR(500),
valid_from TIMESTAMP,
valid_to TIMESTAMP,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT fk_user_cert_user FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
-- Create index for faster lookups by user_id
CREATE INDEX IF NOT EXISTS idx_user_certs_user_id ON user_server_certificates(user_id);
-- Create index for checking certificate expiration
CREATE INDEX IF NOT EXISTS idx_user_certs_valid_to ON user_server_certificates(valid_to);
+41 -42
View File
@@ -2,26 +2,22 @@ plugins {
id "java"
id "jacoco"
id "io.spring.dependency-management" version "1.1.7"
id "org.springframework.boot" version "3.5.6"
id "org.springframework.boot" version "3.5.7"
id "org.springdoc.openapi-gradle-plugin" version "1.9.0"
id "io.swagger.swaggerhub" version "1.3.2"
id "com.diffplug.spotless" version "7.2.1"
id "com.github.jk1.dependency-license-report" version "2.9"
id "com.diffplug.spotless" version "8.1.0"
//id "nebula.lint" version "19.0.3"
id "org.sonarqube" version "6.3.1.5724"
}
import com.github.jk1.license.render.*
ext {
springBootVersion = "3.5.6"
pdfboxVersion = "3.0.5"
springBootVersion = "3.5.7"
pdfboxVersion = "3.0.6"
imageioVersion = "3.12.0"
lombokVersion = "1.18.42"
bouncycastleVersion = "1.82"
springSecuritySamlVersion = "6.5.5"
springSecuritySamlVersion = "6.5.6"
openSamlVersion = "4.3.2"
commonmarkVersion = "0.26.0"
commonmarkVersion = "0.27.0"
googleJavaFormatVersion = "1.28.0"
junitPlatformVersion = "1.12.2"
}
@@ -55,15 +51,39 @@ repositories {
maven { url = 'https://build.shibboleth.net/maven/releases' }
}
allprojects {
group = 'stirling.software'
version = '2.0.0'
allprojects {
group = 'stirling.software'
version = '2.0.1'
configurations.configureEach {
exclude group: 'commons-logging', module: 'commons-logging'
exclude group: "org.springframework.boot", module: "spring-boot-starter-tomcat"
configurations.configureEach {
exclude group: 'commons-logging', module: 'commons-logging'
exclude group: "org.springframework.boot", module: "spring-boot-starter-tomcat"
}
configurations.all {
resolutionStrategy {
force(
'commons-io:commons-io:2.19.0',
'io.micrometer:micrometer-core:1.15.5',
'com.google.zxing:core:3.5.4',
'org.commonmark:commonmark:0.27.0',
'org.commonmark:commonmark-ext-gfm-tables:0.27.0'
)
eachDependency { details ->
if (details.requested.group == 'com.google.code.gson' && details.requested.name == 'gson') {
details.useVersion '2.11.0'
}
if (details.requested.group == 'org.apache.commons' && details.requested.name == 'commons-lang3') {
details.useVersion '3.17.0'
}
if (details.requested.group == 'org.slf4j' && details.requested.name == 'slf4j-api') {
details.useVersion '2.0.13'
}
}
}
}
}
}
tasks.register('writeVersion', WriteProperties) {
destinationFile = layout.projectDirectory.file('app/common/src/main/resources/version.properties')
@@ -115,8 +135,8 @@ subprojects {
implementation 'io.github.pixee:java-security-toolkit:1.2.2'
//tmp for security bumps
implementation 'ch.qos.logback:logback-core:1.5.19'
implementation 'ch.qos.logback:logback-classic:1.5.19'
implementation 'ch.qos.logback:logback-core:1.5.21'
implementation 'ch.qos.logback:logback-classic:1.5.21'
compileOnly "org.projectlombok:lombok:$lombokVersion"
annotationProcessor "org.projectlombok:lombok:$lombokVersion"
@@ -124,7 +144,7 @@ subprojects {
testRuntimeOnly 'org.mockito:mockito-inline:5.2.0'
testRuntimeOnly "org.junit.platform:junit-platform-launcher:$junitPlatformVersion"
testImplementation platform("com.squareup.okhttp3:okhttp-bom:5.1.0")
testImplementation platform("com.squareup.okhttp3:okhttp-bom:5.3.1")
testImplementation "com.squareup.okhttp3:mockwebserver"
}
@@ -220,16 +240,6 @@ gradle.taskGraph.whenReady { graph ->
}
}
def allProjects = ((subprojects as Set<Project>) + project) as Set<Project>
licenseReport {
projects = allProjects
renderers = [new JsonReportRenderer()]
allowedLicensesFile = project.layout.projectDirectory.file("app/allowed-licenses.json").asFile
outputDir = project.layout.buildDirectory.dir("reports/dependency-license").get().asFile.path
configurations = [ "productionRuntimeClasspath", "runtimeClasspath" ]
}
// Configure the forked spring boot run task to properly delegate to the stirling-pdf module
tasks.named('forkedSpringBootRun') {
dependsOn ':stirling-pdf:bootRun'
@@ -253,17 +263,6 @@ spotless {
}
}
sonar {
properties {
property "sonar.projectKey", "Stirling-Tools_Stirling-PDF"
property "sonar.organization", "stirling-tools"
property "sonar.exclusions", "**/build-wrapper-dump.json, **/src/main/java/org/apache/**, **/src/main/resources/static/pdfjs/**, **/src/main/resources/static/pdfjs-legacy/**, **/src/main/resources/static/js/thirdParty/**"
property "sonar.coverage.exclusions", "**/src/main/java/org/apache/**, **/src/main/resources/static/pdfjs/**, **/src/main/resources/static/pdfjs-legacy/**, **/src/main/resources/static/js/thirdParty/**"
property "sonar.cpd.exclusions", "**/src/main/java/org/apache/**, **/src/main/resources/static/pdfjs/**, **/src/main/resources/static/pdfjs-legacy/**, **/src/main/resources/static/js/thirdParty/**"
}
}
swaggerhubUpload {
// dependsOn = generateOpenApiDocs // Depends on your task generating Swagger docs
api = "Stirling-PDF" // The name of your API on SwaggerHub
@@ -284,7 +283,7 @@ dependencies {
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testRuntimeOnly "org.junit.platform:junit-platform-launcher:$junitPlatformVersion"
testImplementation platform("com.squareup.okhttp3:okhttp-bom:5.1.0")
testImplementation platform("com.squareup.okhttp3:okhttp-bom:5.3.1")
testImplementation "com.squareup.okhttp3:mockwebserver"
}
+6 -4
View File
@@ -10,9 +10,11 @@ COPY frontend/package.json frontend/package-lock.json ./
RUN npm ci
COPY frontend .
RUN DISABLE_ADDITIONAL_FEATURES=false npm run build
# Override VITE_API_BASE_URL to use relative paths for production
# This ensures frontend works with nginx proxy setup
RUN DISABLE_ADDITIONAL_FEATURES=false VITE_API_BASE_URL=/ npm run build
# Stage 2: Build Backend
# Stage 2: Build Backend (server-only JAR - no UI)
FROM gradle:8.14-jdk21 AS backend-build
COPY build.gradle .
@@ -27,6 +29,7 @@ RUN ./gradlew build -x spotlessApply -x spotlessCheck -x test -x sonarqube || re
WORKDIR /app
COPY . .
# Build server-only JAR (no frontend, includes security features controlled by DOCKER_ENABLE_SECURITY at runtime)
RUN DISABLE_ADDITIONAL_FEATURES=false \
STIRLING_PDF_DESKTOP_UI=false \
./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube
@@ -62,8 +65,7 @@ COPY docker/unified/nginx.conf /etc/nginx/nginx.conf
COPY docker/unified/entrypoint.sh /entrypoint.sh
# Environment Variables
ENV DISABLE_ADDITIONAL_FEATURES=false \
VERSION_TAG=$VERSION_TAG \
ENV VERSION_TAG=$VERSION_TAG \
JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \
JAVA_CUSTOM_OPTS="" \
HOME=/home/stirlingpdfuser \
+109
View File
@@ -0,0 +1,109 @@
# Unified Ultra-Lite Dockerfile - Frontend + Backend in single container with minimal dependencies
# Supports MODE parameter: BOTH (default), FRONTEND, BACKEND
# Stage 1: Build Frontend
FROM node:20-alpine AS frontend-build
WORKDIR /app
COPY frontend/package.json frontend/package-lock.json ./
RUN npm ci
COPY frontend .
# Override VITE_API_BASE_URL to use relative paths for production
# This ensures frontend works with nginx proxy setup
RUN DISABLE_ADDITIONAL_FEATURES=true VITE_API_BASE_URL=/ npm run build
# Stage 2: Build Backend
FROM gradle:8.14-jdk21 AS backend-build
COPY build.gradle .
COPY settings.gradle .
COPY gradlew .
COPY gradle gradle/
COPY app/core/build.gradle core/.
COPY app/common/build.gradle common/.
COPY app/proprietary/build.gradle proprietary/.
RUN ./gradlew build -x spotlessApply -x spotlessCheck -x test -x sonarqube || return 0
WORKDIR /app
COPY . .
RUN DISABLE_ADDITIONAL_FEATURES=true \
STIRLING_PDF_DESKTOP_UI=false \
./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube
# Stage 3: Final unified ultra-lite image
FROM alpine:3.22.1
ARG VERSION_TAG
# Labels
LABEL org.opencontainers.image.title="Stirling-PDF Unified Ultra-Lite"
LABEL org.opencontainers.image.description="Unified ultra-lite container for Stirling-PDF - Frontend + Backend with minimal dependencies"
LABEL org.opencontainers.image.source="https://github.com/Stirling-Tools/Stirling-PDF"
LABEL org.opencontainers.image.licenses="MIT"
LABEL org.opencontainers.image.vendor="Stirling-Tools"
LABEL org.opencontainers.image.url="https://www.stirlingpdf.com"
LABEL org.opencontainers.image.documentation="https://docs.stirlingpdf.com"
LABEL maintainer="Stirling-Tools"
LABEL org.opencontainers.image.authors="Stirling-Tools"
LABEL org.opencontainers.image.version="${VERSION_TAG}"
LABEL org.opencontainers.image.keywords="PDF, manipulation, unified, ultra-lite, API, Spring Boot, React"
# Copy backend files
COPY scripts/init-without-ocr.sh /scripts/init-without-ocr.sh
COPY scripts/installFonts.sh /scripts/installFonts.sh
COPY --from=backend-build /app/app/core/build/libs/*.jar app.jar
# Copy frontend files
COPY --from=frontend-build /app/dist /usr/share/nginx/html
# Copy nginx configuration
COPY docker/unified/nginx.conf /etc/nginx/nginx.conf
COPY docker/unified/entrypoint.sh /entrypoint.sh
# Environment Variables
ENV DISABLE_ADDITIONAL_FEATURES=false \
VERSION_TAG=$VERSION_TAG \
JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \
JAVA_CUSTOM_OPTS="" \
HOME=/home/stirlingpdfuser \
PUID=1000 \
PGID=1000 \
UMASK=022 \
STIRLING_TEMPFILES_DIRECTORY=/tmp/stirling-pdf \
TMPDIR=/tmp/stirling-pdf \
TEMP=/tmp/stirling-pdf \
TMP=/tmp/stirling-pdf \
MODE=BOTH \
BACKEND_INTERNAL_PORT=8081 \
ENDPOINTS_GROUPS_TO_REMOVE=CLI
# Install minimal dependencies
RUN echo "@main https://dl-cdn.alpinelinux.org/alpine/edge/main" | tee -a /etc/apk/repositories && \
echo "@community https://dl-cdn.alpinelinux.org/alpine/edge/community" | tee -a /etc/apk/repositories && \
echo "@testing https://dl-cdn.alpinelinux.org/alpine/edge/testing" | tee -a /etc/apk/repositories && \
apk upgrade --no-cache -a && \
apk add --no-cache \
ca-certificates \
tzdata \
tini \
bash \
curl \
shadow \
su-exec \
openjdk21-jre \
nginx && \
mkdir -p $HOME /configs /logs /customFiles /pipeline/watchedFolders /pipeline/finishedFolders /tmp/stirling-pdf /pipeline/watchedFolders /pipeline/finishedFolders && \
mkdir -p /usr/share/fonts/opentype/noto /var/lib/nginx/tmp /var/log/nginx && \
chmod +x /scripts/*.sh && \
chmod +x /entrypoint.sh && \
# User permissions
addgroup -S stirlingpdfgroup && adduser -S stirlingpdfuser -G stirlingpdfgroup && \
chown -R stirlingpdfuser:stirlingpdfgroup $HOME /scripts /pipeline /configs /customFiles /pipeline /tmp/stirling-pdf /var/lib/nginx /var/log/nginx /usr/share/nginx && \
chown stirlingpdfuser:stirlingpdfgroup /app.jar
EXPOSE 8080/tcp
ENTRYPOINT ["tini", "--", "/entrypoint.sh"]
+2 -3
View File
@@ -17,7 +17,7 @@ WORKDIR /app
# Copy the entire project to the working directory
COPY . .
# Build the application with DISABLE_ADDITIONAL_FEATURES=false
# Build the application (server-only JAR - no UI, includes security features controlled at runtime)
RUN DISABLE_ADDITIONAL_FEATURES=false \
STIRLING_PDF_DESKTOP_UI=false \
./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube
@@ -44,8 +44,7 @@ LABEL org.opencontainers.image.version="${VERSION_TAG}"
LABEL org.opencontainers.image.keywords="PDF, manipulation, backend, API, Spring Boot"
# Set Environment Variables
ENV DISABLE_ADDITIONAL_FEATURES=false \
VERSION_TAG=$VERSION_TAG \
ENV VERSION_TAG=$VERSION_TAG \
JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \
JAVA_CUSTOM_OPTS="" \
HOME=/home/stirlingpdfuser \
+2 -3
View File
@@ -17,7 +17,7 @@ WORKDIR /app
# Copy the entire project to the working directory
COPY . .
# Build the application with DISABLE_ADDITIONAL_FEATURES=false
# Build the application (server-only JAR - no UI, includes security features controlled at runtime)
RUN DISABLE_ADDITIONAL_FEATURES=false \
STIRLING_PDF_DESKTOP_UI=false \
./gradlew clean build -x spotlessApply -x spotlessCheck -x test -x sonarqube
@@ -35,8 +35,7 @@ COPY --from=build /app/build/libs/restart-helper.jar restart-helper.jar
ARG VERSION_TAG
# Set Environment Variables
ENV DISABLE_ADDITIONAL_FEATURES=true \
VERSION_TAG=$VERSION_TAG \
ENV VERSION_TAG=$VERSION_TAG \
JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \
JAVA_CUSTOM_OPTS="" \
HOME=/home/stirlingpdfuser \
+1 -2
View File
@@ -28,8 +28,7 @@ FROM alpine:3.22.1@sha256:4bcff63911fcb4448bd4fdacec207030997caf25e9bea4045fa6c8
ARG VERSION_TAG
# Set Environment Variables
ENV DISABLE_ADDITIONAL_FEATURES=true \
HOME=/home/stirlingpdfuser \
ENV HOME=/home/stirlingpdfuser \
VERSION_TAG=$VERSION_TAG \
JAVA_BASE_OPTS="-XX:+UnlockExperimentalVMOptions -XX:MaxRAMPercentage=75 -XX:InitiatingHeapOccupancyPercent=20 -XX:+G1PeriodicGCInvokesConcurrent -XX:G1PeriodicGCInterval=10000 -XX:+UseStringDeduplication -XX:G1PeriodicGCSystemLoadThreshold=70" \
JAVA_CUSTOM_OPTS="" \

Some files were not shown because too many files have changed in this diff Show More