Add new resource `random_bytes` to generate an array of random bytes #272

Socolin · 2022-07-08T00:30:55Z

Intended to be used as key or secret

hashicorp-cla · 2022-07-08T00:30:59Z

All committers have signed the CLA.

Socolin · 2022-08-06T22:55:50Z

@bendbennett Hello, is there any chance to see this PR merge (or if it's not something you want, rejected) soon ? I need this I would like to know if at least it's something you are considering or if I should instead create my own provider ?

Socolin · 2022-10-11T19:18:00Z

@bendbennett Have you any ETA ? I really need this and I'm just going to move it to my own provider and close this if it's not going to be merged soon

bendbennett · 2022-10-12T06:45:05Z

@Socolin apologies for delay in responding on this. I'm afraid that I don't have an ETA at this time but I will endeavour to get some feedback to you.

dnlopes · 2022-10-18T15:32:11Z

I'm also waiting badly for this PR to get merged. Have a comment in my code base pointing here 😄

bendbennett

Thanks for the contribution.

Could you rebase on main?
Looks like this PR is using v0.9.0 of terraform-plugin-framework.

CHANGELOG.md

Socolin · 2022-11-30T17:00:30Z

I updated the code, can you please merge this soon ?

sebhaub · 2023-01-09T14:33:41Z

nice - this PR is exactly what i currently miss in the random provider.
@bendbennett is there something missing / preventing to merge this ?

jmgilman · 2023-01-10T18:05:47Z

I'd be willing to help out if it means getting this merged sooner. A huge need for us, thanks!

Socolin · 2023-01-24T18:13:19Z

@bendbennett Do you have an ETA on this ?

bookshelfdave · 2023-01-25T15:21:36Z

We hope to release this in the next few weeks, it's queued behind some other work that we have planned.

bendbennett

@Socolin thank you for your contribution.

Would you be happy to add a couple more tests to verify:

Behaviour of validator on length attribute is as expected.
Altering length forces a replacement.

CHANGELOG.md

internal/provider/resource_bytes.go

docs/resources/bytes.md

maaarghk · 2023-02-14T01:26:37Z

internal/provider/resource_bytes.go

+				Sensitive:   true,
+			},
+			"id": {
+				Description: "The generated bytes presented in string format.",


at a cursory glance I don't think this is accurate, "id" appears to always be set to "none". Other providers have this described as "A static value used internally by Terraform, this should not be referenced in configurations."

Should result be added to actually return the generated bytes in string format? probably a question for @bendbennett - not sure how the state file is expected to behave with binary data in it - or whether it could be achieved in the Read function - or if anyone would ever use it anyway

I did not set result to avoid confusion, since the result is always encoded. But I could add it, we just need to choose if the default is base64 or hex (or other ?)

As the base64 and hex encodings of result are available it doesn't seem like there is a need for result as @Socolin indicates it would need to be encoded.

internal/provider/resource_bytes.go

internal/provider/resource_bytes_test.go

Socolin · 2023-02-14T02:38:04Z

Thanks for the comments, I pushed a fix for them.

maaarghk · 2023-02-14T02:42:44Z

Thanks for the comments, I pushed a fix for them.

Think everything I left looks good, although maybe I obscured a request from Ben for two more tests to be added :)

Socolin · 2023-02-14T04:22:49Z

Thanks for the comments, I pushed a fix for them.

Think everything I left looks good, although maybe I obscured a request from Ben for two more tests to be added :)

Thanks I forgot about this, I'm checking this

… the Update

…uiresReplaceIfValuesNotNull

…erChange that was not failing when it should be

Socolin · 2023-03-13T17:45:21Z

I rebased the branch on main too

ohemelaar · 2023-04-13T12:04:14Z

Hello,
I've been lurking at this PR for a while now, I'm quite interested in using this. I see the PR is approved, is there a specific release schedule that's blocking the merge now?

dominicroessner · 2023-05-10T21:42:16Z

Any update or timeline on when this might go in would really be appreciated. Waiting for this as others. Thank you.

Socolin · 2023-05-10T22:13:11Z

Hello,

@bendbennett What is the next steps for this to be merged and released ?

bendbennett · 2023-05-11T06:53:18Z

Hi @Socolin 👋

I'd like to get an additional approval of the PR prior to merging as these changes are a significant alteration to the random utility provider. The efforts of the team are currently focussed elsewhere at the moment but we will endeavour to focus some attention on this as soon as we're able.

GerardSoleCa · 2023-06-15T20:24:04Z

Hi @bendbennett, another interested party here. I'd really appreciate to have this in the random provider. We are currently generating tokens for akamai CDN which require hex strings, and the only option I saw is to use the random_id resource, but that's a really insecure option since output is not sensitive :(

Hope you get soon a second approval for this PR.

Cheers!

Socolin · 2023-08-28T17:52:48Z

@bendbennett Hello, do you have any ETA or "Not before" date for this ?
I would like to know to take some decision about this, I might publish this in another provider so I can start using it, but I will not do this if it's close to be merged.

bendbennett · 2023-08-30T06:35:05Z

Hi @Socolin and @GerardSoleCa 👋

Apologies for the delay. The focus of the team is currently elsewhere at the moment so it's hard to give an ETA.

Socolin · 2023-08-31T18:14:02Z

To anyone looking for this, I published this in a separate provider

https://registry.terraform.io/providers/Socolin/randombyte/latest

resource "randombyte_bytes" "name" {
length = 64
}

bendbennett · 2023-11-23T15:31:49Z

Hi @Socolin 👋

Apologies for the delay in getting back to you. We have recently discussed your PR, and, if you're still amenable, we would like to move forward with the addition of the random_bytes resource.

The following suggestions came out of our discussion:

Could result_base64, and result_hex be renamed base64, and hex, respectively?
Could id be removed? Just to clarify, it is not used by practitioners, it is not required for the provider supported versions of Terraform (>= 0.12), and it is no longer needed for testing purposes (i.e., when the terraform-plugin-testing module is used).
With the addition of random_bytes, it would likely be valuable to update the documentation for both random_id, and random_bytes to provide some clarification around the use-case for using one or other of these two resources. The most obvious differentiator being when the output would be considered sensitive, and should not be displayed in CLI console output.

Thank you again for your contribution, and sorry it has taken a while for us to get back to you.

bendbennett · 2023-11-30T10:55:07Z

Hi @Socolin 👋

I've incoporated all of your commits into Add random_bytes resource.

If you'd rather update this PR with the suggestions in this comment, then that would be great. If not, then we'll move forward with Add random_bytes resource.

Many thanks for all your work on this, and apologies for the delay.

Socolin · 2023-11-30T14:30:42Z

Hello,

I'm working on other project right now, you can move forward with your PR, Thanks :)

<Actions> <action id="296d75eab55b9d23bd1e94dc34cea43b964c29945c12fefcb674e3c068a0a767"> <h3>Bump Terraform `random` provider version</h3> <details id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24"> <summary>Update Terraform lock file</summary> <p>"hashicorp/random" updated from "3.5.1" to "3.6.0" in file ".terraform.lock.hcl"</p> <details> <summary>3.6.0</summary> <pre>Changelog retrieved from:
	https://github.com/hashicorp/terraform-provider-random/releases/tag/v3.6.0
FEATURES:

* resource/random_bytes: New resource that generates an array of random bytes intended to be used as key or secret ([#272](https://github.com/hashicorp/terraform-provider-random/issues/272))


</pre> </details> </details> <a href="https://infra.ci.jenkins.io/job/terraform-jobs/job/azure/job/main/918/">Jenkins pipeline link</a> </action> </Actions> --- <table> <tr> <td width="77"> <img src="https://www.updatecli.io/images/updatecli.png" alt="Updatecli logo" width="50" height="50"> </td> <td> <p> Created automatically by <a href="https://www.updatecli.io/">Updatecli</a> </p> <details><summary>Options:</summary> <br /> <p>Most of Updatecli configuration is done via <a href="https://www.updatecli.io/docs/prologue/quick-start/">its manifest(s)</a>.</p> <ul> <li>If you close this pull request, Updatecli will automatically reopen it, the next time it runs.</li> <li>If you close this pull request and delete the base branch, Updatecli will automatically recreate it, erasing all previous commits made.</li> </ul> <p> Feel free to report any issues at <a href="https://github.com/updatecli/updatecli/issues">github.com/updatecli/updatecli</a>.<br /> If you find this tool useful, do not hesitate to star <a href="https://github.com/updatecli/updatecli/stargazers">our GitHub repository</a> as a sign of appreciation, and/or to tell us directly on our <a href="https://matrix.to/#/#Updatecli_community:gitter.im">chat</a>! </p> </details> </td> </tr> </table> Co-authored-by: Jenkins Infra Bot (updatecli) <[email protected]> Co-authored-by: Damien Duportal <[email protected]>

github-actions · 2024-05-24T09:47:29Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

Socolin requested a review from a team as a code owner July 8, 2022 00:30

github-actions bot added documentation size/L labels Jul 8, 2022

edjackson-wf mentioned this pull request Jul 29, 2022

General random bytes, perhaps base64 encoded? #63

Closed

bendbennett added the tf-devex-triage label Aug 15, 2022

bendbennett self-assigned this Aug 15, 2022

bendbennett reviewed Oct 24, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Socolin force-pushed the random_bytes branch from 45f5132 to 0578ee9 Compare November 30, 2022 17:00

bookshelfdave added tf-devex-triage and removed tf-devex-triage labels Jan 25, 2023

bendbennett reviewed Feb 9, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

internal/provider/resource_bytes.go Outdated Show resolved Hide resolved

internal/provider/resource_bytes.go Outdated Show resolved Hide resolved

maaarghk suggested changes Feb 14, 2023

View reviewed changes

Socolin force-pushed the random_bytes branch from 0578ee9 to 0839bdf Compare February 14, 2023 02:37

Socolin force-pushed the random_bytes branch from 0f82f05 to a0911a7 Compare February 14, 2023 04:45

github-actions bot removed the size/L label Feb 14, 2023

Socolin added 10 commits March 13, 2023 13:41

Add test to validate random_bytes it checking length

ba1d7b4

Add test to validate change of length in random_bytes

817352c

Remove unused link in change

8936fde

Add tests for keepers of random_bytes

f7b042c

Fix discrepancy between the plan and the state in random_bytes during…

197d2bf

… the Update

Run make generate to update random_bytes doc

c344e92

Add comment explaining why random_bytes is using mapplanmodifiers.Req…

3003529

…uiresReplaceIfValuesNotNull

Remove outdated comment

ecd97a8

Add test to validate that after import the resource does not changes.

396e4ef

Fix TestAccResourceBytes_ImportWithoutKeepersThenUpdateShouldNotTrigg…

a528090

…erChange that was not failing when it should be

Socolin force-pushed the random_bytes branch from d573dae to a528090 Compare March 13, 2023 17:41

Fix acceptance test of random_bytes after rebase

dad27ac

bendbennett approved these changes Mar 14, 2023

View reviewed changes

bendbennett mentioned this pull request Nov 30, 2023

Add random_bytes resource #494

Merged

bendbennett closed this in #494 Dec 1, 2023

github-actions bot locked as resolved and limited conversation to collaborators May 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new resource `random_bytes` to generate an array of random bytes #272

Add new resource `random_bytes` to generate an array of random bytes #272

Socolin commented Jul 8, 2022

hashicorp-cla commented Jul 8, 2022 •

edited

Loading

Socolin commented Aug 6, 2022

Socolin commented Oct 11, 2022

bendbennett commented Oct 12, 2022

dnlopes commented Oct 18, 2022

bendbennett left a comment

Socolin commented Nov 30, 2022 •

edited

Loading

sebhaub commented Jan 9, 2023

jmgilman commented Jan 10, 2023

Socolin commented Jan 24, 2023

bookshelfdave commented Jan 25, 2023

bendbennett left a comment

maaarghk Feb 14, 2023

Socolin Feb 14, 2023

bendbennett Feb 14, 2023

Socolin commented Feb 14, 2023

maaarghk commented Feb 14, 2023

Socolin commented Feb 14, 2023

Socolin commented Mar 13, 2023

ohemelaar commented Apr 13, 2023

dominicroessner commented May 10, 2023

Socolin commented May 10, 2023

bendbennett commented May 11, 2023

GerardSoleCa commented Jun 15, 2023

Socolin commented Aug 28, 2023

bendbennett commented Aug 30, 2023

Socolin commented Aug 31, 2023 •

edited

Loading

bendbennett commented Nov 23, 2023

bendbennett commented Nov 30, 2023

Socolin commented Nov 30, 2023

github-actions bot commented May 24, 2024

Add new resource random_bytes to generate an array of random bytes #272

Add new resource random_bytes to generate an array of random bytes #272

Conversation

Socolin commented Jul 8, 2022

hashicorp-cla commented Jul 8, 2022 • edited Loading

Socolin commented Aug 6, 2022

Socolin commented Oct 11, 2022

bendbennett commented Oct 12, 2022

dnlopes commented Oct 18, 2022

bendbennett left a comment

Choose a reason for hiding this comment

Socolin commented Nov 30, 2022 • edited Loading

sebhaub commented Jan 9, 2023

jmgilman commented Jan 10, 2023

Socolin commented Jan 24, 2023

bookshelfdave commented Jan 25, 2023

bendbennett left a comment

Choose a reason for hiding this comment

maaarghk Feb 14, 2023

Choose a reason for hiding this comment

Socolin Feb 14, 2023

Choose a reason for hiding this comment

bendbennett Feb 14, 2023

Choose a reason for hiding this comment

Socolin commented Feb 14, 2023

maaarghk commented Feb 14, 2023

Socolin commented Feb 14, 2023

Socolin commented Mar 13, 2023

ohemelaar commented Apr 13, 2023

dominicroessner commented May 10, 2023

Socolin commented May 10, 2023

bendbennett commented May 11, 2023

GerardSoleCa commented Jun 15, 2023

Socolin commented Aug 28, 2023

bendbennett commented Aug 30, 2023

Socolin commented Aug 31, 2023 • edited Loading

bendbennett commented Nov 23, 2023

bendbennett commented Nov 30, 2023

Socolin commented Nov 30, 2023

github-actions bot commented May 24, 2024

Add new resource `random_bytes` to generate an array of random bytes #272

Add new resource `random_bytes` to generate an array of random bytes #272

hashicorp-cla commented Jul 8, 2022 •

edited

Loading

Socolin commented Nov 30, 2022 •

edited

Loading

Socolin commented Aug 31, 2023 •

edited

Loading