Add ability to provide a CA cert when making requests to SUMA #2391
Conversation
This file contains 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
jamie-suse
added
enhancement
| response = | ||
| url | ||
| |> get_suma_api_url() | ||
| |> http_executor().get_system_id(auth, fully_qualified_domain_name) | ||
| |> http_executor().get_system_id(auth, fully_qualified_domain_name, ca_cert != nil) |
There was a problem hiding this comment.
an alternative to this ca_cert != nil repetition could be expecting as an argument use_ca_cert as we do in the http executor, meaning we move the ca_cert != nil in the genserver. What do you think?
|
|
||
| defp setup_auth(%State{} = state) do | ||
| with {:ok, %{url: url, username: username, password: password, ca_cert: ca_cert}} <- | ||
| SoftwareUpdates.get_settings(), | ||
| {:ok, auth_cookie} <- SumaApi.login(url, username, password) do | ||
| :ok <- maybe_write_ca_cert_file(ca_cert), | ||
| {:ok, auth_cookie} <- SumaApi.login(url, username, password, ca_cert) do |
There was a problem hiding this comment.
If we decide to have SumaApi functions accept a use_ca_cert as mentioned here we could also think of centralizing that ca_cert =! nil in the genserver state that we set in this function 👀
dottorblaster
requested changes
Mar 7, 2024
Comment on lines
123
to
140
| defp maybe_write_ca_cert_file(nil), do: File.rm(SumaApi.ca_cert_path()) | ||
|
|
||
| defp maybe_write_ca_cert_file(ca_cert) do | ||
| SumaApi.ca_cert_path() | ||
| |> Path.dirname() | ||
| |> File.mkdir_p!() | ||
|
|
||
| File.write(SumaApi.ca_cert_path(), ca_cert) | ||
| end |
There was a problem hiding this comment.
To me File.rm and File.write are two different forms of writing, so this can just be names write, without the maybe
Suggested change
| defp maybe_write_ca_cert_file(nil), do: File.rm(SumaApi.ca_cert_path()) | |
| defp maybe_write_ca_cert_file(ca_cert) do | |
| SumaApi.ca_cert_path() | |
| |> Path.dirname() | |
| |> File.mkdir_p!() | |
| File.write(SumaApi.ca_cert_path(), ca_cert) | |
| end | |
| defp write_ca_cert_file(nil), do: File.rm(SumaApi.ca_cert_path()) | |
| defp write_ca_cert_file(ca_cert) do | |
| SumaApi.ca_cert_path() | |
| |> Path.dirname() | |
| |> File.mkdir_p!() | |
| File.write(SumaApi.ca_cert_path(), ca_cert) | |
| end |
| HTTPoison.get( | ||
| "#{base_url}/system/getRelevantErrata?sid=#{system_id}", | ||
| [{"Content-type", "application/json"}], | ||
| hackney: [cookie: [auth]], | ||
| ssl: [verify: :verify_none] | ||
| hackney: [cookie: [auth]] ++ maybe_provide_ssl_options(use_ca_cert) |
There was a problem hiding this comment.
Suggested change
| hackney: [cookie: [auth]] ++ maybe_provide_ssl_options(use_ca_cert) | |
| hackney: [cookie: [auth]] ++ ssl_options(use_ca_cert) |
Comment on lines
68
to
71
| defp maybe_provide_ssl_options(true), | ||
| do: [ssl: [verify: :verify_peer, certfile: SumaApi.ca_cert_path()]] | ||
|
|
||
| defp maybe_provide_ssl_options(_), do: [] |
There was a problem hiding this comment.
Suggested change
| defp maybe_provide_ssl_options(true), | |
| do: [ssl: [verify: :verify_peer, certfile: SumaApi.ca_cert_path()]] | |
| defp maybe_provide_ssl_options(_), do: [] | |
| defp ssl_options(true), | |
| do: [ssl: [verify: :verify_peer, certfile: SumaApi.ca_cert_path()]] | |
| defp ssl_options(_), do: [] |
This was referenced Mar 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This change adds ability to provide a CA cert when making requests to SUMA.
Because the HTTPoison library uses Erlang library hackney underneath, whose API demands that we provide a path to a file containing the certificate; we need to save a certificate file on the filesystem somewhere. Note that if we save some new credentials that don't contain a certificate (i.e. the user clears the certificate), then the old certificate file is removed.
How was this tested?
Added unit tests for this new functionality.