https://github.com/keyfactor/signserver-signing-action
Action for signing with SignServer
https://github.com/keyfactor/signserver-signing-action
signserver-signing-action
Last synced: 3 months ago
JSON representation
Action for signing with SignServer
- Host: GitHub
- URL: https://github.com/keyfactor/signserver-signing-action
- Owner: Keyfactor
- License: apache-2.0
- Created: 2024-05-08T12:36:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-29T12:03:03.000Z (over 1 year ago)
- Last Synced: 2025-06-05T06:27:34.136Z (8 months ago)
- Topics: signserver-signing-action
- Homepage:
- Size: 108 KB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# SignServer Signing action
The SignServer Signing action can return a signed input produced by the provided SignServer endpoint and upload it as an artifact for access or further use.
## Get started
A running SignServer instance with the needed worker configured.
### Prerequisities
A running SignServer instance with the needed worker configured.
The supported workers as well as authentication types are listed below.
### Supported workers
The current version of this action supports 3 types of workers:
* `JArchiveSigner`: takes jar as input and uploads signed jar as artifact
* `PDFSigner`: takes pdf as input and uploads signed pdf as artifact
* `PlainSigner`: takes any input and uploads signed input as artifact
### Supported authentication types
The following authentication types are supported:
* `NOAUTH` - will be used as default if no clientcert is provided
* `CLIENTCERT` - need to provide clientcert and password for authentication
### Input parameters
`endpoint`: (Required) The SignServer signing endpoint.
`file-path`: (Required) The path to the file to be signed.
`worker-name`: (Required) The name of the Signer to use for the signing.
`worker-type`: (Required) The type of worker.
`client-cert`: (Optional) The client cert needed for authorization.
`password`: (Optional) Password for clientcert.
### Example usage
```
jobs:
testing:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Sign Jar
uses: ./ ** change to correct action name **
with:
endpoint: http://localhost:80/signserver
file-path: $GITHUB_WORKSPACE/input-file
worker-name: PlainSigner
worker-type: PlainSigner
```
## Community Support
In the [Keyfactor Community](https://www.keyfactor.com/community/), we welcome contributions.
The SignServer Signing action is open-source and community-supported, meaning that **no SLA** is applicable.
* To report a problem or suggest a new feature, use the [Issues](https://github.com/Keyfactor/signserver-signing-action/issues) tab.
* If you want to contribute actual bug fixes or proposed enhancements, see the [Contributing Guidelines](CONTRIBUTING.md) and go to [Pull requests](../../pulls).
* Ask the community for ideas: [SignServer Discussions](https://github.com/Keyfactor/signserver-ce/discussions).
* Read more in our documentation: [SignServer Documentation](https://doc.primekey.com/signserver).
* See release information: [SignServer Release information](https://doc.primekey.com/signserver/signserver-release-information).
* Read more on the open source project website: [SignServer website](https://www.signserver.org/).
## Commercial Support
Commercial support is available for [SignServer Enterprise](https://www.keyfactor.com/platform/keyfactor-signserver-enterprise/).
## License
For License information, see [LICENSE](https://github.com/Keyfactor/signserver-signing-action/blob/main/LICENSE)