@@ -0,0 +1,287 @@ |
| 1 | +// SPDX-License-Identifier: AGPL-3.0-or-later |
| 2 | + |
| 3 | +// Package exec renders workflow expressions into the shell/env surface used |
| 4 | +// by runner engines. It is deliberately separate from the Docker engine so |
| 5 | +// every future engine consumes the same taint boundary. |
| 6 | +package exec |
| 7 | + |
| 8 | +import ( |
| 9 | + "fmt" |
| 10 | + "sort" |
| 11 | + "strconv" |
| 12 | + "strings" |
| 13 | + |
| 14 | + "github.com/tenseleyFlow/shithub/internal/actions/expr" |
| 15 | +) |
| 16 | + |
| 17 | +const defaultBindingPrefix = "SHITHUB_INPUT_" |
| 18 | + |
| 19 | +type Bindings struct { |
| 20 | + prefix string |
| 21 | + next int |
| 22 | + env map[string]string |
| 23 | +} |
| 24 | + |
| 25 | +func NewBindings(prefix string) *Bindings { |
| 26 | + if strings.TrimSpace(prefix) == "" { |
| 27 | + prefix = defaultBindingPrefix |
| 28 | + } |
| 29 | + return &Bindings{prefix: prefix, env: map[string]string{}} |
| 30 | +} |
| 31 | + |
| 32 | +func (b *Bindings) Add(value string) string { |
| 33 | + name := b.prefix + strconv.Itoa(b.next) |
| 34 | + b.next++ |
| 35 | + b.env[name] = value |
| 36 | + return name |
| 37 | +} |
| 38 | + |
| 39 | +func (b *Bindings) Env() map[string]string { |
| 40 | + out := make(map[string]string, len(b.env)) |
| 41 | + for k, v := range b.env { |
| 42 | + out[k] = v |
| 43 | + } |
| 44 | + return out |
| 45 | +} |
| 46 | + |
| 47 | +type ResolvedText struct { |
| 48 | + Text string |
| 49 | + Tainted bool |
| 50 | +} |
| 51 | + |
| 52 | +type RenderedStep struct { |
| 53 | + Run string |
| 54 | + Env map[string]string |
| 55 | + EnvTaint map[string]bool |
| 56 | +} |
| 57 | + |
| 58 | +type StepInput struct { |
| 59 | + Run string |
| 60 | + JobEnv map[string]string |
| 61 | + StepEnv map[string]string |
| 62 | + Context expr.Context |
| 63 | +} |
| 64 | + |
| 65 | +func RenderStep(in StepInput) (RenderedStep, error) { |
| 66 | + ctx := cloneContext(&in.Context) |
| 67 | + bindings := NewBindings("") |
| 68 | + |
| 69 | + env, taint, err := resolveEnv(in.JobEnv, &ctx) |
| 70 | + if err != nil { |
| 71 | + return RenderedStep{}, fmt.Errorf("render job env: %w", err) |
| 72 | + } |
| 73 | + mergeContextEnv(&ctx, env, taint) |
| 74 | + |
| 75 | + stepEnv, stepTaint, err := resolveEnv(in.StepEnv, &ctx) |
| 76 | + if err != nil { |
| 77 | + return RenderedStep{}, fmt.Errorf("render step env: %w", err) |
| 78 | + } |
| 79 | + for k, v := range stepEnv { |
| 80 | + env[k] = v |
| 81 | + if stepTaint[k] { |
| 82 | + taint[k] = true |
| 83 | + } else { |
| 84 | + delete(taint, k) |
| 85 | + } |
| 86 | + } |
| 87 | + mergeContextEnv(&ctx, stepEnv, stepTaint) |
| 88 | + |
| 89 | + run, err := RenderShell(in.Run, &ctx, bindings) |
| 90 | + if err != nil { |
| 91 | + return RenderedStep{}, err |
| 92 | + } |
| 93 | + for k, v := range bindings.Env() { |
| 94 | + env[k] = v |
| 95 | + } |
| 96 | + return RenderedStep{Run: run, Env: env, EnvTaint: taint}, nil |
| 97 | +} |
| 98 | + |
| 99 | +func RenderShell(raw string, ctx *expr.Context, bindings *Bindings) (string, error) { |
| 100 | + if bindings == nil { |
| 101 | + bindings = NewBindings("") |
| 102 | + } |
| 103 | + var out strings.Builder |
| 104 | + if err := walkExpressions(raw, func(literal, body string) error { |
| 105 | + if body == "" { |
| 106 | + out.WriteString(literal) |
| 107 | + return nil |
| 108 | + } |
| 109 | + out.WriteString(literal) |
| 110 | + v, err := eval(body, ctx) |
| 111 | + if err != nil { |
| 112 | + return err |
| 113 | + } |
| 114 | + if v.Tainted { |
| 115 | + out.WriteString("${") |
| 116 | + out.WriteString(bindings.Add(v.String())) |
| 117 | + out.WriteString("}") |
| 118 | + return nil |
| 119 | + } |
| 120 | + out.WriteString(v.String()) |
| 121 | + return nil |
| 122 | + }); err != nil { |
| 123 | + return "", err |
| 124 | + } |
| 125 | + return out.String(), nil |
| 126 | +} |
| 127 | + |
| 128 | +func ResolveText(raw string, ctx *expr.Context) (ResolvedText, error) { |
| 129 | + var out strings.Builder |
| 130 | + tainted := false |
| 131 | + if err := walkExpressions(raw, func(literal, body string) error { |
| 132 | + if body == "" { |
| 133 | + out.WriteString(literal) |
| 134 | + return nil |
| 135 | + } |
| 136 | + out.WriteString(literal) |
| 137 | + v, err := eval(body, ctx) |
| 138 | + if err != nil { |
| 139 | + return err |
| 140 | + } |
| 141 | + if v.Tainted { |
| 142 | + tainted = true |
| 143 | + } |
| 144 | + out.WriteString(v.String()) |
| 145 | + return nil |
| 146 | + }); err != nil { |
| 147 | + return ResolvedText{}, err |
| 148 | + } |
| 149 | + return ResolvedText{Text: out.String(), Tainted: tainted}, nil |
| 150 | +} |
| 151 | + |
| 152 | +func resolveEnv(raw map[string]string, ctx *expr.Context) (map[string]string, map[string]bool, error) { |
| 153 | + out := make(map[string]string, len(raw)) |
| 154 | + taint := make(map[string]bool, len(raw)) |
| 155 | + for _, key := range sortedKeys(raw) { |
| 156 | + if strings.HasPrefix(key, defaultBindingPrefix) { |
| 157 | + return nil, nil, fmt.Errorf("%s uses reserved runner input prefix %s", key, defaultBindingPrefix) |
| 158 | + } |
| 159 | + v, err := ResolveText(raw[key], ctx) |
| 160 | + if err != nil { |
| 161 | + return nil, nil, fmt.Errorf("%s: %w", key, err) |
| 162 | + } |
| 163 | + out[key] = v.Text |
| 164 | + if v.Tainted { |
| 165 | + taint[key] = true |
| 166 | + } |
| 167 | + } |
| 168 | + return out, taint, nil |
| 169 | +} |
| 170 | + |
| 171 | +func eval(body string, ctx *expr.Context) (expr.Value, error) { |
| 172 | + if ctx == nil { |
| 173 | + c := expr.Context{Untrusted: expr.DefaultUntrusted()} |
| 174 | + ctx = &c |
| 175 | + } |
| 176 | + toks, err := expr.Lex(strings.TrimSpace(body)) |
| 177 | + if err != nil { |
| 178 | + return expr.Value{}, err |
| 179 | + } |
| 180 | + ast, err := expr.Parse(toks) |
| 181 | + if err != nil { |
| 182 | + return expr.Value{}, err |
| 183 | + } |
| 184 | + return expr.Eval(ast, ctx) |
| 185 | +} |
| 186 | + |
| 187 | +func walkExpressions(raw string, fn func(literal, body string) error) error { |
| 188 | + for { |
| 189 | + start := strings.Index(raw, "${{") |
| 190 | + if start < 0 { |
| 191 | + return fn(raw, "") |
| 192 | + } |
| 193 | + end := strings.Index(raw[start+3:], "}}") |
| 194 | + if end < 0 { |
| 195 | + return fmt.Errorf("render expression: missing closing }}") |
| 196 | + } |
| 197 | + end += start + 3 |
| 198 | + if err := fn(raw[:start], raw[start+3:end]); err != nil { |
| 199 | + return err |
| 200 | + } |
| 201 | + raw = raw[end+2:] |
| 202 | + } |
| 203 | +} |
| 204 | + |
| 205 | +func cloneContext(ctx *expr.Context) expr.Context { |
| 206 | + if ctx == nil { |
| 207 | + return expr.Context{Untrusted: expr.DefaultUntrusted()} |
| 208 | + } |
| 209 | + out := *ctx |
| 210 | + out.Secrets = cloneStringMap(ctx.Secrets) |
| 211 | + out.Vars = cloneStringMap(ctx.Vars) |
| 212 | + out.Env = cloneStringMap(ctx.Env) |
| 213 | + out.EnvTaint = cloneBoolMap(ctx.EnvTaint) |
| 214 | + out.Untrusted = cloneSet(ctx.Untrusted) |
| 215 | + out.Shithub.Event = cloneAnyMap(ctx.Shithub.Event) |
| 216 | + return out |
| 217 | +} |
| 218 | + |
| 219 | +func mergeContextEnv(ctx *expr.Context, env map[string]string, taint map[string]bool) { |
| 220 | + if ctx.Env == nil { |
| 221 | + ctx.Env = map[string]string{} |
| 222 | + } |
| 223 | + if ctx.EnvTaint == nil { |
| 224 | + ctx.EnvTaint = map[string]bool{} |
| 225 | + } |
| 226 | + for k, v := range env { |
| 227 | + ctx.Env[k] = v |
| 228 | + if taint[k] { |
| 229 | + ctx.EnvTaint[k] = true |
| 230 | + } else { |
| 231 | + delete(ctx.EnvTaint, k) |
| 232 | + } |
| 233 | + } |
| 234 | +} |
| 235 | + |
| 236 | +func sortedKeys(m map[string]string) []string { |
| 237 | + keys := make([]string, 0, len(m)) |
| 238 | + for k := range m { |
| 239 | + keys = append(keys, k) |
| 240 | + } |
| 241 | + sort.Strings(keys) |
| 242 | + return keys |
| 243 | +} |
| 244 | + |
| 245 | +func cloneStringMap(in map[string]string) map[string]string { |
| 246 | + if len(in) == 0 { |
| 247 | + return nil |
| 248 | + } |
| 249 | + out := make(map[string]string, len(in)) |
| 250 | + for k, v := range in { |
| 251 | + out[k] = v |
| 252 | + } |
| 253 | + return out |
| 254 | +} |
| 255 | + |
| 256 | +func cloneBoolMap(in map[string]bool) map[string]bool { |
| 257 | + if len(in) == 0 { |
| 258 | + return nil |
| 259 | + } |
| 260 | + out := make(map[string]bool, len(in)) |
| 261 | + for k, v := range in { |
| 262 | + out[k] = v |
| 263 | + } |
| 264 | + return out |
| 265 | +} |
| 266 | + |
| 267 | +func cloneSet(in map[string]struct{}) map[string]struct{} { |
| 268 | + if len(in) == 0 { |
| 269 | + return expr.DefaultUntrusted() |
| 270 | + } |
| 271 | + out := make(map[string]struct{}, len(in)) |
| 272 | + for k, v := range in { |
| 273 | + out[k] = v |
| 274 | + } |
| 275 | + return out |
| 276 | +} |
| 277 | + |
| 278 | +func cloneAnyMap(in map[string]any) map[string]any { |
| 279 | + if len(in) == 0 { |
| 280 | + return nil |
| 281 | + } |
| 282 | + out := make(map[string]any, len(in)) |
| 283 | + for k, v := range in { |
| 284 | + out[k] = v |
| 285 | + } |
| 286 | + return out |
| 287 | +} |