Files
yq/pkg/yqlib/decoder_base64.go
MsfPabloandPablo Garcia 5efa5ffcd8 feat: add @base64url/@base64urld operators (RFC 4648 §5) (#2827)
Add the URL- and filename-safe Base64 variant alongside the existing
@base64/@base64d operators. The URL-safe alphabet replaces + and / with
- and _ so encoded values can be embedded in URLs, filenames, or other
contexts where + and / have special meaning.

Adds:
- Base64UrlFormat registered in the Formats slice (also exposes
  base64url as a top-level --input/--output-format)
- NewBase64URLEncoder / NewBase64URLDecoder backed by base64.URLEncoding
- @base64url / @base64urld lexer tokens (placed before @base64/@base64d
  so the longer patterns match first under Go's leftmost-first regex)
- no_base64.go stubs for the yq_nobase64 build tag
- operator tests covering encode, decode, round-trip, and missing-padding
  decode

Closes #2794

Co-authored-by: Pablo Garcia <[email protected]>
2026-09-15 15:54:05 +10:00

78 lines
2.0 KiB
Go

//go:build !yq_nobase64
package yqlib
import (
"bytes"
"encoding/base64"
"io"
"strings"
)
type base64Decoder struct {
reader io.Reader
finished bool
readAnything bool
encoding base64.Encoding
}
func NewBase64Decoder() Decoder {
return &base64Decoder{finished: false, encoding: *base64.StdEncoding}
}
// NewBase64URLDecoder returns a decoder for the URL- and filename-safe
// Base64 variant (RFC 4648 §5): `-` and `_` replace `+` and `/`.
// The shared padding logic in Init tolerates inputs with or without padding.
func NewBase64URLDecoder() Decoder {
return &base64Decoder{finished: false, encoding: *base64.URLEncoding}
}
func (dec *base64Decoder) Init(reader io.Reader) error {
// Read all data from the reader and strip leading/trailing whitespace
// This is necessary because base64 decoding needs to see the complete input
// to handle padding correctly, and we need to strip whitespace before decoding.
buf := new(bytes.Buffer)
if _, err := buf.ReadFrom(reader); err != nil {
return err
}
// Strip leading and trailing whitespace
stripped := strings.TrimSpace(buf.String())
// Add padding if needed (base64 strings should be a multiple of 4 characters)
padLen := len(stripped) % 4
if padLen > 0 {
stripped += strings.Repeat("=", 4-padLen)
}
// Create a new reader from the stripped and padded data
dec.reader = strings.NewReader(stripped)
dec.readAnything = false
dec.finished = false
return nil
}
func (dec *base64Decoder) Decode() (*CandidateNode, error) {
if dec.finished {
return nil, io.EOF
}
base64Reader := base64.NewDecoder(&dec.encoding, dec.reader)
buf := new(bytes.Buffer)
if _, err := buf.ReadFrom(base64Reader); err != nil {
return nil, err
}
if buf.Len() == 0 {
dec.finished = true
// if we've read _only_ an empty string, lets return that
// otherwise if we've already read some bytes, and now we get
// an empty string, then we are done.
if dec.readAnything {
return nil, io.EOF
}
}
dec.readAnything = true
return createStringScalarNode(buf.String()), nil
}