Skip to content

Commit

Permalink
Add documentation about supported hashing algorithms (#32)
Browse files Browse the repository at this point in the history
* Add documentation on inputs page about hashing algorithms

* Add documentation about hashing algorithms to README
  • Loading branch information
japarson committed Jun 6, 2024
1 parent 3656866 commit 1d39813
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,16 +153,16 @@ files-catalog: ${{ github.workspace }}\catalog.txt

### Digest Algorithm
```yaml
# The name of the digest algorithm used for hashing the file being signed. The default value is SHA256.
file-digest: SHA384
# The name of the digest algorithm used for hashing the file being signed. The supported values are SHA256, SHA384, and SHA512. The default value is SHA256.
file-digest: SHA256
```

### Timestamping
```yaml
# A URL to an RFC3161 compliant timestamping service.
timestamp-rfc3161: http://timestamp.acs.microsoft.com

# The name of the digest algorithm used for timestamping.
# The name of the digest algorithm used for timestamping. The supported values are SHA256, SHA384, and SHA512.
timestamp-digest: SHA256
```

Expand Down
6 changes: 4 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,17 @@ inputs:
a separate line. Can be combined with the files-folder input.
required: false
file-digest:
description: The name of the digest algorithm used for hashing the files being signed (e.g. SHA256).
description: The name of the digest algorithm used for hashing the files being signed. The supported
values are SHA256, SHA384, and SHA512.
required: false
default: 'SHA256'
timestamp-rfc3161:
description: A URL to an RFC3161 compliant timestamping service.
required: false
default: 'http://timestamp.acs.microsoft.com'
timestamp-digest:
description: The name of the digest algorithm used for timestamping.
description: The name of the digest algorithm used for timestamping. The supported values are SHA256,
SHA384, and SHA512.
required: false
default: 'SHA256'
append-signature:
Expand Down

0 comments on commit 1d39813

Please sign in to comment.