Create new flag to set default hash function

Open
#276 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
go

Research direction

Start in fluxcd/pkg by locating the existing flag handling and checksum-related entry points. Define the default-hash-function flag scope, then trace its rollout through source-controller, helm-controller, kustomize-controller, notification-controller, and flux2. Done means Flux-provided checksums use the configured default across all listed controllers while Hash HostNames remains SHA1.

Written by the indexing model from the issue text.

Description

enhancement

The controllers use hash functions to generate checksum of artifacts, which is later used for change and anti-tampering detection.
Users would benefit by being able to set what algorithms to be used across the board, which align with their performance, security and regulation requirements.

The scope of this flag is only around checksums provided by Flux itself. It won't be able to change algorithms used for things defined elsewhere, for example, the algorithm used for Hash HostNames cannot be changed, as only SHA1 is supported.

Outstanding tasks
  • Create new flag handler (fluxcd/pkg)
  • Roll-out across projects
    • source-controller
    • helm-controller
    • kustomize-controller
    • notification-controller
    • flux2 (set default across all controllers)
Dominant language
Go
Stars
63
Forks
162
Avg merge
9h 54m
Merged PRs (30d)
29

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from fluxcd/pkg

All issues in fluxcd/pkg

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.