Skip to content
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

Remove secrets.json #153

Closed
Callum027 opened this issue Nov 9, 2023 · 0 comments · Fixed by #155
Closed

Remove secrets.json #153

Callum027 opened this issue Nov 9, 2023 · 0 comments · Fixed by #155
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@Callum027
Copy link
Member

Callum027 commented Nov 9, 2023

When I originally designed Buildarr, it was normal for Sonarr and Radarr to expose their API keys on their initialize.js[on] endpoints, allowing them to be dynamically fetched. To avoid doing this every time, I decided to cache them using a secrets.json file.

However, some issues have since become glaringly obvious:

  • The secrets.json file is difficult to manage from a security standpoint, as it is unencrypted and is not created using a secure umask by Buildarr by default at the moment
  • Whenever plugins have a major update and have no means of migrating older secrets model objects, older secrets.json files will cause validation errors when running the updated versions
  • With new versions of Arr suite applications moving to a forced-authentication model, where the API key must be provided by the client, there is simply no need to cache these credentials in a separate file anymore

Therefore, I have decided to remove management of the file in the next release. From now on, the only codepath will the "uncached" one.

Secrets models themselves will remain as they are for the moment, as they are a critical part of passing application metadata and credentials to the resource management code.

@Callum027 Callum027 added the enhancement New feature or request label Nov 9, 2023
@Callum027 Callum027 added this to the v0.6.3 milestone Nov 9, 2023
@Callum027 Callum027 self-assigned this Nov 9, 2023
@Callum027 Callum027 modified the milestones: v0.6.3, v0.7.0 Nov 11, 2023
@Callum027 Callum027 linked a pull request Nov 11, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant