Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mircobabin/buildstamp
BuildStamp is a compilation tool. It stamps the compilation date/time into a source file, adjusts VersionInfo.rc resource. And digitally signs produced executables, just like signtool.exe.
https://github.com/mircobabin/buildstamp
codesigning compilation delphi versioninfo
Last synced: about 1 month ago
JSON representation
BuildStamp is a compilation tool. It stamps the compilation date/time into a source file, adjusts VersionInfo.rc resource. And digitally signs produced executables, just like signtool.exe.
- Host: GitHub
- URL: https://github.com/mircobabin/buildstamp
- Owner: MircoBabin
- License: other
- Created: 2023-01-11T15:50:20.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T07:43:17.000Z (9 months ago)
- Last Synced: 2024-04-09T08:46:55.683Z (9 months ago)
- Topics: codesigning, compilation, delphi, versioninfo
- Language: C#
- Homepage:
- Size: 1.09 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/MircoBabin/BuildStamp/releases)
[](https://github.com/MircoBabin/BuildStamp/blob/master/LICENSE.md)
# BuildStamp
BuildStamp is a compilation tool. Use BuildStamp in the Pre-build event to inject compilation date/time and adjust the versionumber in the VersionInfo resource file.
- It stamps the compilation date/time into a source file
- It updates the VersionInfo.rc resource file with a versionumber listed in a sourcefile.
- It can also digitally sign any executable. The codesign certificate can be on disk or in [KeePass](https://keepass.info/ "KeePass").
# Download binary
For Windows (.NET framework 4), [the latest version can be found here](https://github.com/MircoBabin/BuildStamp/releases/latest "Latest Version").
Download the zip and unpack it somewhere.
*For digitally signing using certificates stored in [KeePass](https://keepass.info/ "KeePass") also install [KeePassCommander](https://github.com/MircoBabin/KeePassCommander "KeePassCommander").*
The minimum .NET framework required is 4.0.
*For unattended automatic installation scripts, read the section "Automatic installation scripts" lower down the page.*
# Help
Execute **BuildStamp.exe** without parameters to view the help.
```
BuildStamp version 2.3
https://github.com/MircoBabin/BuildStamp - MIT license
BuildStamp is a compilation tool.
It stamps the compilation date/time into a source file, using the Pre-build event.
It can also digitally sign any executable. The codesign certificate can be on disk or in KeePass.
----------------------------------------------------
----------------------------------------------------
--- ---
--- Stamp compilation date/time into source file ---
--- ---
----------------------------------------------------
----------------------------------------------------
Syntax: BuildStamp.exe stamp --filename --language
{--outputfilename }
{--datetime yyyy-mm-ddThh:mm:ss+HH:MM}
{--launchdebugger}
- With --language the programming language is specified.
Supported languages: "CSharp", "Pascal".
- When --outputfilename is ommitted, the will be overwritten.
- With --datetime (e.g. "1975-09-12T23:30:00+02:00") the 'current time' can be provided.
When ommitted the current time from the system clock will be used.
- When the debug switch --launchdebugger is encountered, a request to launch the debugger is started.
has to contain:
//
Inside is replaced with yyyy-mm-dd in local time.
Inside is replaced with hh:mm:ss in local time.
Inside is replaced with a full ISO-8601 time.
Inside is replaced with yyyy-mm-dd in UTC time.
Inside is replaced with hh:mm:ss in UTC time.
Inside is replaced with a full ISO-8601 time with timezone Z (UTC).
//
e.g. for Pascal source: BuildStamp.exe stamp --filename c:\...\Compiled.pas --language pascal
unit Compiled;
interface
//
const COMPILEDATE = '';
const COMPILETIME = '';
//
implementation
end.
It is recommended for the to only contain BuildStamp metadata.
And no other metadata like versionnumber, buildnumber, copyright, etc.
Because adding other metadata does not play well with version control (Git).
----------------------------------------------------
----------------------------------------------------
--- ---
--- Stamp VersionInfo resource file (.rc) ---
--- ---
----------------------------------------------------
----------------------------------------------------
Syntax: BuildStamp.exe stamp-versioninfo --versionfilename --language
--filename
{--outputfilename }
{--launchdebugger}
- With --language the programming language of is specified.
- When --outputfilename is ommitted, the will be overwritten.
- When the debug switch --launchdebugger is encountered, a request to launch the debugger is started.
has to contain the version string between 2 markers. E.g. for Pascal source:
unit Version;
interface
const VersionString =
{}
'4.076'
{};
implementation
end.
has to contain the version number.
//
Inside is replaced with "major,minor,patch,build".
Inside is replaced with "major.minor.patch.build".
Inside is replaced with the full version inside .
//
e.g. for Pascal resource file: BuildStamp.exe stamp-versioninfo --versionfilename c:\...\Version.pas --language pascal --filename c:\...\VersionInfo.rc
VersionInfo.rc contents:
//
1 VERSIONINFO
FILEVERSION
PRODUCTVERSION
FILEOS 0x4
FILETYPE 0x1
{
BLOCK "StringFileInfo"
{
BLOCK "040904E4"
{
VALUE L"CompanyName", L"My Company\000"
VALUE L"FileDescription", L"My Program\000"
VALUE L"FileVersion", L">\000"
VALUE L"LegalCopyright", L"(c) My Company\000"
VALUE L"ProductName", L"My Program\000"
VALUE L"ProductVersion", L"\000"
VALUE L"ProgramID", L"MyProgram\000" // Delphi specific. Must be the projectname, e.g. MyProgram.dproj
}
}
BLOCK "VarFileInfo"
{
VALUE "Translation", 0x0409 0x04E4
}
}
//
---------------------------------
---------------------------------
--- ---
--- Digitally sign executable ---
--- ---
---------------------------------
---------------------------------
Syntax: BuildStamp.exe sign --filename
{--certificate }
{--certificate-password }
{--keepasscommander-path } like c:\KeePass\Plugins
{--keepass-certificate-title } like "My Code Signing Certificate"
{--keepass-certificate-attachment } like "certificate.p12"
{--keepass-certificate-password } like "Certificate Password". When omitted the default password field is used.
{--sign-with-authenticode-timestamp-url } like http://timestamp.digicert.com
{--sign-with-sha256-rfc3161-timestamp-url } like http://timestamp.digicert.com
{--launchdebugger}
Digitally signs .
With --certificate and --certificate-password the certificate is read from a file on disk.
With --keepasscommander-path and --keepass-certificate-... the certificate is retrieved from the KeePass password store. The KeePass plugin KeepassCommander https://github.com/MircoBabin/KeePassCommander is used for retrieval.
Attention: --keepass-certificate-attachment references an attachmentname in the KeePass entry with title <--keepass-certificate-title>.
Attention: --keepass-certificate-password references a fieldname in the KeePass entry with title <--keepass-certificate-title>, and must not provide the real password.
---------------
---------------
--- ---
--- License ---
--- ---
---------------
---------------
BuildStamp
MIT license
Copyright (c) 2023 Mirco Babin
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
```
# Documentation
- [Delphi documentation](docs/Delphi/README.md "Delphi documentation")
- [Digitally sign documentation](docs/DigitallySign.md "Digitally sign documentation")
# Why
Delphi doesn't have a good way to embed the compilation date/time into the executable. There is a solution reading the linker timestamp from the PE Header of the executable. But that PE Header solution is too complex and low-level in my opinion.
Delphi also lacks updating the Version Info resource in a usable way, when the versionnumber is already present in a sourcefile.
So I wrote BuildStamp for injecting the compilation date/time and adjusting the Version Info via Pre-build event. The modified source file is then compiled into the executable.
The Microsoft provided [signtool.exe](https://learn.microsoft.com/en-us/windows/win32/seccrypto/signtool "signtool.exe") can only be officially installed with the "Microsoft Windows Software Development Kit (SDK)".
I wanted a standalone executable that can be distributed standalone. And I wanted the ability to store the code signing certificate in [KeePass](https://keepass.info/ "KeePass"). That's why I added the "sign" command.
# Automatic installation scripts
For unattended installation scripts the following flow can be used for the latest version:
1) Download https://github.com/MircoBabin/BuildStamp/releases/latest/download/release.download.zip.url-location
2) Read the text of this file into **latest-download-url**. The file only contains an url, so the encoding is ASCII. *The encoding UTF-8 may also be used to read the file, because ASCII is UTF-8 encoding.*
3) Download the zip from the **latest-download-url** to local file **BuildStamp.zip**. *Each release carries the version number in the filename. To prevent not knowing the downloaded filename, download to a fixed local filename.*
4) Unpack the downloaded **BuildStamp.zip**.
# Contributions
Contributions are welcome. Please read [CONTRIBUTING.md](CONTRIBUTING.md "contributing") before making any contribution!
# License
[The license is MIT.](LICENSE.md "license")