ek9_generate_signing_keys
Answers with keysGenerated and publicKeyPath after ensuring the user-global signing keypair (~/.ek9/private.pem + public.pem) that ek9_deploy_package signs with exists; an existing pair is never overwritten.
When to use it
'Set up the signing keys for this machine' is one call with no arguments. A once-per-developer or once-per-CI-environment step; ek9_deploy_package does it itself when the keys are missing, so it is rarely needed explicitly.
When not to use it
- Signing and publishing a package - use
ek9_deploy_package(it generates missing keys). - Bumping a package version before publishing - use
ek9_increment_version.
Details
No parameters; -Gk takes no source file. The keys are a user-global 1024-bit RSA pair at ~/.ek9/private.pem and ~/.ek9/public.pem, reused by every project on the machine; to rotate, delete the two .pem files and re-call. keysGenerated is true only when the pair did not exist before the call and exists after it; a generation failure is status:bad-arguments (exit 2) with the CLI's stderr.
Arguments
| Argument | Type | Required | What it is |
|---|---|---|---|
verbosity | string: full | summary | none | Response size. The default answers with status, summary, keysGenerated and publicKeyPath; 'full' adds the CLI's stdout, argv, exitCode, elapsedMs and timedOut. |
Recorded calls
Real calls, recorded against small projects and checked on every build - a changed answer fails it.
Generate shape
Request
{ }
Response
{
"keysGenerated" : false,
"meta" : {
"serverMs" : "<timing>"
},
"publicKeyPath" : "~/.ek9/public.pem",
"status" : "ok",
"summary" : "signing keys already present - not regenerated"
}
See also
- Show me in the IDE: Build: package, install, sign, deploy