Skip to content

Add support for custom hash calculation function, allowing content streaming #41

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

Conversation

idangutman-ms
Copy link

@idangutman-ms idangutman-ms commented Feb 3, 2025

Name of feature:

Hash calculation function support

Pain or issue this feature alleviates:

This change provides the ability to add a custom function for calculating the content hash.

This is useful for calculating the hash of the content as it is being streamed, instead of requiring the entire content to be loaded into memory, and is necessary for calculating hashes on large files without excessive memory usage.

Why is this important to the project (if not answered above):

Is there documentation on how to use this feature? If so, where?

Example for usage can be seen in test file, where instead of setting p7.Content, we use the p7.HashCalc (setting Content is optional when using HashCalc):

	reader := bytes.NewReader([]byte(longBuffer))
	p7.HashCalc = func(h hash.Hash, b []byte) []byte {
		bufferSize := 128
		buffer := make([]byte, bufferSize)
		for {
			count, err := reader.Read(buffer)
			if err != nil {
				break
			}
			h.Write(buffer[:count])
		}
		return h.Sum(nil)
	}

In what environments or workflows is this feature supported?

In what environments or workflows is this feature explicitly NOT supported (if any)?

Supporting links/other PRs/issues:

💔Thank you!

@hslatman hslatman self-assigned this Feb 5, 2025
hslatman added a commit that referenced this pull request Feb 10, 2025
Original work done by idangutman-ms in #41.
@hslatman hslatman merged commit ef6b696 into smallstep:main Feb 11, 2025
13 checks passed
@hslatman
Copy link
Member

Thanks for your contribution, @idangutman-ms 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants