Skip to content

Add fields for TLS material to destination config #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mtrmac merged 2 commits into from
Sep 25, 2025
Merged

Add fields for TLS material to destination config #340

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5765e3e
Add fields for TLS material to destination config
meln5674 Sep 12, 2025
8e9b008
tls: remote "file" from field names
meln5674 Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions common/docs/containers.conf.5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -929,11 +929,24 @@ URI to access the Podman service
- **rootless remote** - ssh://user@engineering.lab.company.com/run/user/1000/podman/podman.sock
- **rootful local** - unix:///run/podman/podman.sock
- **rootful remote** - ssh://root@10.10.1.136:22/run/podman/podman.sock
- **tcp/tls remote** - tcp://10.10.1.136:9443

**identity="~/.ssh/id_rsa**

Path to file containing ssh identity key

**tls_cert_file="/path/to/certs/podman/tls.crt"**
Copy link
Copy Markdown
Contributor

@ashley-cui ashley-cui Sep 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for here.

Copy link
Copy Markdown
Contributor Author

@meln5674 meln5674 Sep 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


Path to PEM file containing TLS client certificate

**tls_key_file="/path/to/certs/podman/tls.key"**

Path to PEM file containing TLS client certificate private key

**tls_ca_file="/path/to/certs/podman/ca.crt"**

Path to PEM file containing TLS certificate authority (CA) bundle

**[engine.runtimes_flags]**

Lists of default runtime flags for each valid OCI runtime (crun, runc, kata, runsc, krun, etc).
Expand Down
7 changes: 7 additions & 0 deletions common/pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,6 +707,13 @@ type Destination struct {
// Identity file with ssh key, optional
Identity string `json:",omitempty" toml:"identity,omitempty"`

// Path to TLS client certificate PEM file, optional
TLSCertFile string `json:",omitempty" toml:"tls_cert_file,omitempty"`
// Path to TLS client certificate private key PEM file, optional
TLSKeyFile string `json:",omitempty" toml:"tls_key_file,omitempty"`
// Path to TLS certificate authority PEM file, optional
TLSCAFile string `json:",omitempty" toml:"tls_ca_file,omitempty"`
Copy link
Copy Markdown
Contributor

@ashley-cui ashley-cui Sep 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, one last nit, can we change these to just TLSCert TLSKey TLSCA? The file part seems redundant and changing them would match the flags in podman.

Copy link
Copy Markdown
Contributor Author

@meln5674 meln5674 Sep 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


// isMachine describes if the remote destination is a machine.
IsMachine bool `json:",omitempty" toml:"is_machine,omitempty"`
}
Expand Down
20 changes: 19 additions & 1 deletion common/pkg/config/connections_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ var _ = Describe("Connections conf", func() {
})

Context("GetConnection/Farm", func() {
const defConnectionsConf = `{"Connection":{"Default":"test","Connections":{"test":{"URI":"ssh://podman.io"},"QA":{"URI":"ssh://test","Identity":".ssh/id","IsMachine":true}}},"farm":{"Default":"farm1","List":{"farm1":["test"]}}}`
const defConnectionsConf = `{"Connection":{"Default":"test","Connections":{"test":{"URI":"ssh://podman.io"},"QA":{"URI":"ssh://test","Identity":".ssh/id","IsMachine":true},"TLS": {"URI": "tcp://podman.io:443", "TLSCAFile":"/path/to/ca.pem"},"mTLS":{"URI": "tcp://podman.io:443/subpath", "TLSCAFile": "/path/to/ca.pem", "TLSCertFile": "/path/to/tls.crt", "TLSKeyFile": "/path/to/tls.key"}}},"farm":{"Default":"farm1","List":{"farm1":["test"]}}}`
const defContainersConf = `
[engine]
active_service = "containers"
Expand Down Expand Up @@ -158,6 +158,24 @@ var _ = Describe("Connections conf", func() {
Destination: Destination{URI: "ssh://test", Identity: ".ssh/id", IsMachine: true},
}))

con, err = conf.GetConnection("TLS", false)
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(con).To(gomega.Equal(&Connection{
Name: "TLS",
Default: false,
ReadWrite: true,
Destination: Destination{URI: "tcp://podman.io:443", TLSCAFile: "/path/to/ca.pem"},
}))

con, err = conf.GetConnection("mTLS", false)
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(con).To(gomega.Equal(&Connection{
Name: "mTLS",
Default: false,
ReadWrite: true,
Destination: Destination{URI: "tcp://podman.io:443/subpath", TLSCAFile: "/path/to/ca.pem", TLSCertFile: "/path/to/tls.crt", TLSKeyFile: "/path/to/tls.key"},
}))

con, err = conf.GetConnection("containers", false)
gomega.Expect(err).ToNot(gomega.HaveOccurred())
gomega.Expect(con).To(gomega.Equal(&Connection{
Expand Down
7 changes: 7 additions & 0 deletions common/pkg/config/containers.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,10 +777,17 @@ default_sysctls = [
# rootful "unix:///run/podman/podman.sock (Default)
# remote rootless ssh://engineering.lab.company.com/run/user/1000/podman/podman.sock
# remote rootful ssh://root@10.10.1.136:22/run/podman/podman.sock
# tcp/tls remote tcp://10.10.1.136:9443
#
# uri = "ssh://user@production.example.com/run/user/1001/podman/podman.sock"
# Path to file containing ssh identity key
# identity = "~/.ssh/id_rsa"
# Path to PEM file containing TLS client certificate
# tls_cert_file = "/path/to/certs/podman/tls.crt"
# Path to PEM file containing TLS client certificate private key
# tls_key_file = "/path/to/certs/podman/tls.key"
# Path to PEM file containing TLS certificate authority (CA) bundle
# tls_ca_file = "/path/to/certs/podman/ca.crt"

# Directory for temporary files. Must be tmpfs (wiped after reboot)
#
Expand Down
7 changes: 7 additions & 0 deletions common/pkg/config/containers.conf-freebsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,10 +598,17 @@ default_sysctls = [
# rootful "unix:///run/podman/podman.sock (Default)
# remote rootless ssh://engineering.lab.company.com/run/user/1000/podman/podman.sock
# remote rootful ssh://root@10.10.1.136:22/run/podman/podman.sock
# tcp/tls remote tcp://10.10.1.136:9443
#
# uri = "ssh://user@production.example.com/run/user/1001/podman/podman.sock"
# Path to file containing ssh identity key
# identity = "~/.ssh/id_rsa"
# Path to PEM file containing TLS client certificate
# tls_cert_file = "/path/to/certs/podman/tls.crt"
# Path to PEM file containing TLS client certificate private key
# tls_key_file = "/path/to/certs/podman/tls.key"
# Path to PEM file containing TLS certificate authority (CA) bundle
# tls_ca_file = "/path/to/certs/podman/ca.crt"

# Directory for temporary files. Must be tmpfs (wiped after reboot)
#
Expand Down