-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Support (m)TLS API Socket #24601
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.
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
openshift-merge-bot
merged 1 commit into
containers:main
from
meln5674:feature/remote-tls
Sep 30, 2025
Merged
Support (m)TLS API Socket #24601
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,7 +27,7 @@ var ( | |
"destination" is one of the form: | ||
[user@]hostname (will default to ssh) | ||
ssh://[user@]hostname[:port][/path] (will obtain socket path from service, if not given.) | ||
tcp://hostname:port (not secured) | ||
tcp://hostname:port (not secured without TLS enabled) | ||
unix://path (absolute path required) | ||
`, | ||
RunE: add, | ||
|
@@ -36,6 +36,7 @@ var ( | |
podman system connection add --identity ~/.ssh/dev_rsa testing ssh://[email protected]:2222 | ||
podman system connection add --identity ~/.ssh/dev_rsa --port 22 production [email protected] | ||
podman system connection add debug tcp://localhost:8080 | ||
podman system connection add production-tls --tls-ca=ca.crt --tls-cert=tls.crt --tls-key=tls.key tcp://localhost:8080 | ||
`, | ||
} | ||
|
||
|
@@ -51,11 +52,14 @@ var ( | |
dockerPath string | ||
|
||
cOpts = struct { | ||
Identity string | ||
Port int | ||
UDSPath string | ||
Default bool | ||
Farm string | ||
Identity string | ||
Port int | ||
UDSPath string | ||
Default bool | ||
Farm string | ||
TLSCertFile string | ||
TLSKeyFile string | ||
TLSCAFile string | ||
}{} | ||
) | ||
|
||
|
@@ -74,6 +78,18 @@ func init() { | |
flags.StringVar(&cOpts.Identity, identityFlagName, "", "path to SSH identity file") | ||
_ = addCmd.RegisterFlagCompletionFunc(identityFlagName, completion.AutocompleteDefault) | ||
|
||
tlsCertFileFlagName := "tls-cert" | ||
flags.StringVar(&cOpts.TLSCertFile, tlsCertFileFlagName, "", "path to TLS client certificate PEM file") | ||
_ = addCmd.RegisterFlagCompletionFunc(tlsCertFileFlagName, completion.AutocompleteDefault) | ||
|
||
tlsKeyFileFlagName := "tls-key" | ||
flags.StringVar(&cOpts.TLSKeyFile, tlsKeyFileFlagName, "", "path to TLS client certificate private key PEM file") | ||
_ = addCmd.RegisterFlagCompletionFunc(tlsKeyFileFlagName, completion.AutocompleteDefault) | ||
|
||
tlsCAFileFlagName := "tls-ca" | ||
flags.StringVar(&cOpts.TLSCAFile, tlsCAFileFlagName, "", "path to TLS certificate Authority PEM file") | ||
_ = addCmd.RegisterFlagCompletionFunc(tlsCAFileFlagName, completion.AutocompleteDefault) | ||
|
||
socketPathFlagName := "socket-path" | ||
flags.StringVar(&cOpts.UDSPath, socketPathFlagName, "", "path to podman socket on remote host. (default '/run/podman/podman.sock' or '/run/user/{uid}/podman/podman.sock)") | ||
_ = addCmd.RegisterFlagCompletionFunc(socketPathFlagName, completion.AutocompleteDefault) | ||
|
@@ -139,14 +155,24 @@ func add(cmd *cobra.Command, args []string) error { | |
return fmt.Errorf("invalid ssh mode") | ||
} | ||
|
||
if uri.Scheme != "tcp" { | ||
if cmd.Flags().Changed("tls-cert") { | ||
return fmt.Errorf("--tls-cert option not supported for %s scheme", uri.Scheme) | ||
} | ||
if cmd.Flags().Changed("tls-key") { | ||
return fmt.Errorf("--tls-key option not supported for %s scheme", uri.Scheme) | ||
} | ||
if cmd.Flags().Changed("tls-ca") { | ||
return fmt.Errorf("--tls-ca option not supported for %s scheme", uri.Scheme) | ||
} | ||
} | ||
switch uri.Scheme { | ||
case "ssh": | ||
return ssh.Create(entities, sshMode) | ||
case "unix": | ||
if cmd.Flags().Changed("identity") { | ||
return errors.New("--identity option not supported for unix scheme") | ||
} | ||
|
||
if cmd.Flags().Changed("socket-path") { | ||
uri.Path = cmd.Flag("socket-path").Value.String() | ||
} | ||
|
@@ -169,6 +195,9 @@ func add(cmd *cobra.Command, args []string) error { | |
if cmd.Flags().Changed("identity") { | ||
return errors.New("--identity option not supported for tcp scheme") | ||
} | ||
if cmd.Flags().Changed("tls-cert") != cmd.Flags().Changed("tls-key") { | ||
return errors.New("--tls-cert and --tls-key options must be both provided if one is provided") | ||
} | ||
if uri.Port() == "" { | ||
return errors.New("tcp scheme requires a port either via --port or in destination URL") | ||
} | ||
|
@@ -179,6 +208,9 @@ func add(cmd *cobra.Command, args []string) error { | |
dst := config.Destination{ | ||
URI: uri.String(), | ||
Identity: cOpts.Identity, | ||
TLSCert: cOpts.TLSCertFile, | ||
TLSKey: cOpts.TLSKeyFile, | ||
TLSCA: cOpts.TLSCAFile, | ||
} | ||
|
||
connection := args[0] | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There’s some precedent to special-casing
--format=…
values (in particular we accept--format json
in places), and to an extent I appreciate the ergonomics, but, on the principle of the thing, I personally dislike values that have two different semantics. If--format hello
outputs literal "hello", it’s inconsistent that--format tls
does not output literal "tls".I’m not authoritative for Podman, and note that this was pre-approved in #24601 (comment) .