Skip to content

Commit 124d99d

Browse files
bfladbflad
committed
feat: Initial Standard and URL implementations
0 parents  commit 124d99d

19 files changed

Lines changed: 2409 additions & 0 deletions

‎.github/dependabot.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "gomod"
4+
directory: "/"
5+
schedule:
6+
interval: "daily"
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
9+
schedule:
10+
interval: "daily"

‎.github/workflows/ci.yml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- .github/workflows/ci.yml
7+
- .golangci.yml
8+
- go.mod
9+
- '**.go'
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
golangci-lint:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
19+
- uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
20+
with:
21+
go-version-file: 'go.mod'
22+
- run: go mod download
23+
- uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 # v8.0.0
24+
with:
25+
version: v2.1
26+
27+
test:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
31+
- uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0
32+
with:
33+
go-version-file: 'go.mod'
34+
- run: go mod download
35+
- run: go test -v -cover -timeout=120s -parallel=4 ./...

‎.golangci.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
version: "2"
2+
3+
formatters:
4+
enable:
5+
- gofmt
6+
7+
linters:
8+
default: none
9+
enable:
10+
- errcheck
11+
- govet
12+
- ineffassign
13+
- misspell
14+
- paralleltest
15+
- staticcheck
16+
- unconvert
17+
- unparam
18+
- unused
19+
20+
issues:
21+
max-issues-per-linter: 0
22+
max-same-issues: 0

‎LICENSE‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to the Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by the Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding any notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
Copyright 2026 Speakeasy Development, Inc.
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.

‎README.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# terraform-plugin-framework-base64types
2+
3+
[![Go Reference](https://pkg.go.dev/badge/github.com/speakeasy-api/terraform-plugin-framework-base64types.svg)](https://pkg.go.dev/github.com/speakeasy-api/terraform-plugin-framework-base64types)
4+
5+
Terraform Plugin Framework [custom type](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/types/custom) implementations for base64 encoded strings ([RFC 4648](https://www.rfc-editor.org/rfc/rfc4648)).
6+
7+
## Types
8+
9+
### Standard (RFC 4648, Section 4)
10+
11+
The `Standard` type represents a base64 encoded string using the standard alphabet (`A-Z`, `a-z`, `0-9`, `+`, `/`) with `=` padding. This is the encoding used by Terraform's [`filebase64()`](https://developer.hashicorp.com/terraform/language/functions/filebase64) and [`base64encode()`](https://developer.hashicorp.com/terraform/language/functions/base64encode) functions, making `Standard` the appropriate custom type for schema attributes that receive output from these functions.
12+
13+
**Use `Standard` when:**
14+
15+
- The attribute receives output from Terraform's `filebase64()` function (e.g. binary file content)
16+
- The attribute receives output from Terraform's `base64encode()` function
17+
- The API expects standard base64 encoding
18+
19+
#### Schema Definition
20+
21+
```go
22+
schema.StringAttribute{
23+
CustomType: base64types.StandardType{},
24+
Required: true,
25+
Description: "Binary file content, base64-encoded. Use filebase64() to encode files.",
26+
}
27+
```
28+
29+
#### Data Model
30+
31+
```go
32+
type ResourceModel struct {
33+
FileContent base64types.Standard `tfsdk:"file_content"`
34+
}
35+
```
36+
37+
#### Accessing Decoded Bytes
38+
39+
```go
40+
decoded, diags := data.FileContent.ValueBytes()
41+
```
42+
43+
#### Creating From Bytes
44+
45+
```go
46+
data.FileContent = base64types.NewStandardValueFromBytes(responseBytes)
47+
```
48+
49+
### URL (RFC 4648, Section 5)
50+
51+
The `URL` type represents a base64url encoded string using the URL and filename safe alphabet (`A-Z`, `a-z`, `0-9`, `-`, `_`) with `=` padding. The base64url encoding substitutes `-` for `+` and `_` for `/` to avoid characters that have special meaning in URLs and filenames.
52+
53+
**Use `URL` when:**
54+
55+
- The attribute contains base64 data that must be URL-safe (e.g. JWT tokens, URL parameters)
56+
- The API expects base64url encoding
57+
58+
#### Schema Definition
59+
60+
```go
61+
schema.StringAttribute{
62+
CustomType: base64types.URLType{},
63+
Required: true,
64+
Description: "URL-safe base64-encoded token.",
65+
}
66+
```
67+
68+
#### Data Model
69+
70+
```go
71+
type ResourceModel struct {
72+
Token base64types.URL `tfsdk:"token"`
73+
}
74+
```
75+
76+
#### Accessing Decoded Bytes
77+
78+
```go
79+
decoded, diags := data.Token.ValueBytes()
80+
```
81+
82+
#### Creating From Bytes
83+
84+
```go
85+
data.Token = base64types.NewURLValueFromBytes(responseBytes)
86+
```
87+
88+
## Validation
89+
90+
Both types automatically validate attribute values and provider-defined function parameter values via the `xattr.ValidateableAttribute` and `function.ValidateableParameter` interfaces. Invalid base64 input produces plan-time errors with guidance on how to fix the value.
91+
92+
## Semantic Equality
93+
94+
Both types implement `basetypes.StringValuableWithSemanticEquals` to compare the decoded bytes rather than the encoded strings. This prevents spurious Terraform diffs when two base64 strings decode to the same content.
95+
96+
## License
97+
98+
[Apache License, Version 2.0](LICENSE)

‎base64types/diagnostics.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package base64types
2+
3+
import "errors"
4+
5+
// decodeErrors joins one or two non-nil errors into a single string for
6+
// diagnostic messages.
7+
func decodeErrors(err1, err2 error) string {
8+
return errors.Join(err1, err2).Error()
9+
}

‎base64types/doc.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Package base64types contains Terraform Plugin Framework Custom Type
2+
// implementations for base64 encoded strings (RFC 4648).
3+
//
4+
// Standard (Section 4) uses the standard base64 alphabet (+, /) with padding
5+
// and is the appropriate type for receiving Terraform filebase64() and
6+
// base64encode() function output.
7+
//
8+
// URL (Section 5) uses the URL and filename safe base64 alphabet (-, _) with
9+
// padding and is appropriate for values that must be safe for use in URLs and
10+
// filenames.
11+
package base64types

0 commit comments

Comments
 (0)