|
| 1 | +#!/usr/bin/env ruby |
| 2 | +# Validate the complete release; strict external callers supply --expect. |
| 3 | +require 'yaml' |
| 4 | +require 'date' |
| 5 | +# Strict callers provide expectations independently of rendered annotations. |
| 6 | +expectations = [] |
| 7 | +until ARGV.empty? |
| 8 | + abort 'usage: check-external-policy.rb [--expect DEPLOYMENT POLICY NAMESPACE]...' unless ARGV.shift == '--expect' && ARGV.length >= 3 |
| 9 | + expectations << ARGV.shift(3) |
| 10 | +end |
| 11 | +input = STDIN.read |
| 12 | +resources = YAML.parse_stream(input).children.map do |doc| |
| 13 | + stream = Psych::Nodes::Stream.new |
| 14 | + stream.children << doc |
| 15 | + YAML.safe_load(stream.to_yaml, permitted_classes: [Date, Time], aliases: true) |
| 16 | +end.compact |
| 17 | +# Match Kubernetes Unstructured.IsList: an items array, including typed lists. |
| 18 | +# https://github.com/kubernetes/apimachinery/blob/v0.34.1/pkg/apis/meta/v1/unstructured/unstructured.go |
| 19 | +def flatten_resources(resource, enclosing_hooks = {}) |
| 20 | + annotations = resource.dig('metadata', 'annotations') || {} |
| 21 | + hooks = enclosing_hooks.merge(annotations.select { |k, _| %w[helm.sh/hook argocd.argoproj.io/hook].include?(k) }) |
| 22 | + if resource['items'].is_a?(Array) |
| 23 | + resource.fetch('items').flat_map { |item| flatten_resources(item, hooks) } |
| 24 | + else |
| 25 | + unless hooks.empty? |
| 26 | + resource = Marshal.load(Marshal.dump(resource)) |
| 27 | + resource['metadata'] ||= {} |
| 28 | + resource['metadata']['annotations'] = annotations.merge(hooks) |
| 29 | + end |
| 30 | + [resource] |
| 31 | + end |
| 32 | +end |
| 33 | +resources = resources.flat_map { |resource| flatten_resources(resource) } |
| 34 | +def label_value?(value) |
| 35 | + value.is_a?(String) && value.length <= 63 && (value.empty? || /\A[A-Za-z0-9](?:[-_.A-Za-z0-9]*[A-Za-z0-9])?\z/.match?(value)) |
| 36 | +end |
| 37 | + |
| 38 | +def label_key?(key) |
| 39 | + return false unless key.is_a?(String) |
| 40 | + parts = key.split('/', -1) |
| 41 | + return false unless [1, 2].include?(parts.length) && !parts.last.empty? && label_value?(parts.last) |
| 42 | + return true if parts.length == 1 |
| 43 | + prefix = parts.first |
| 44 | + prefix.length <= 253 && /\A[a-z0-9](?:[-a-z0-9]*[a-z0-9])?(?:\.[a-z0-9](?:[-a-z0-9]*[a-z0-9])?)*\z/.match?(prefix) |
| 45 | +end |
| 46 | +annotation = 'buzz.block.xyz/external-network-policy' |
| 47 | +expectations.each do |deployment_name, policy_name, namespace| |
| 48 | + candidates = resources.select do |r| |
| 49 | + r['kind'] == 'Deployment' && r.dig('metadata', 'name') == deployment_name && |
| 50 | + (r.dig('metadata', 'namespace').to_s.empty? ? namespace : r.dig('metadata', 'namespace')) == namespace |
| 51 | + end |
| 52 | + abort "external policy #{policy_name}: expected exactly one deployment #{deployment_name}" unless candidates.length == 1 |
| 53 | + annotations = candidates.first.dig('metadata', 'annotations') || {} |
| 54 | + abort "external policy #{policy_name}: missing or overwritten ownership marker" unless annotations[annotation] == policy_name && annotations['buzz.block.xyz/release-namespace'] == namespace |
| 55 | +end |
| 56 | +resources.select { |r| r['kind'] == 'Deployment' }.each do |deployment| |
| 57 | + name = deployment.dig('metadata', 'annotations', annotation) |
| 58 | + next unless name |
| 59 | + release_namespace = deployment.dig('metadata', 'annotations', 'buzz.block.xyz/release-namespace') |
| 60 | + abort "external policy #{name}: missing release namespace" if !release_namespace.is_a?(String) || release_namespace.empty? |
| 61 | + namespace = deployment.dig('metadata', 'namespace') |
| 62 | + namespace = release_namespace if namespace.nil? || namespace.empty? |
| 63 | + policies = resources.select do |r| |
| 64 | + r['apiVersion'] == 'networking.k8s.io/v1' && r['kind'] == 'NetworkPolicy' && |
| 65 | + r.dig('metadata', 'name') == name && |
| 66 | + (r.dig('metadata', 'namespace').to_s.empty? ? release_namespace : r.dig('metadata', 'namespace')) == namespace |
| 67 | + end |
| 68 | + abort "external policy #{name}: expected exactly one replacement in #{namespace}" unless policies.length == 1 |
| 69 | + abort "external policy #{name}: replacement must not be a Helm hook" if policies.first.dig('metadata', 'annotations', 'helm.sh/hook') |
| 70 | + abort "external policy #{name}: replacement must not be an Argo CD hook" if policies.first.dig('metadata', 'annotations', 'argocd.argoproj.io/hook') |
| 71 | + spec = policies.first.fetch('spec') |
| 72 | + labels = deployment.dig('spec', 'template', 'metadata', 'labels') |
| 73 | + selector = spec.fetch('podSelector') |
| 74 | + # Require the immutable runtime identity explicitly, not a namespace-wide policy. |
| 75 | + identity = deployment.dig('spec', 'selector', 'matchLabels') |
| 76 | + match = selector.fetch('matchLabels', {}) |
| 77 | + expressions = selector.fetch('matchExpressions', []) |
| 78 | + identity_bound = identity.all? do |k, v| |
| 79 | + match[k] == v || expressions.any? { |e| e['key'] == k && e['operator'] == 'In' && e['values'] == [v] } |
| 80 | + end |
| 81 | + abort "external policy #{name}: missing runtime identity selector" unless identity_bound |
| 82 | + abort "external policy #{name}: selector does not match runtime" unless match.all? { |k, v| labels[k] == v } |
| 83 | + selector.fetch('matchExpressions', []).each do |expression| |
| 84 | + key = expression.fetch('key') |
| 85 | + values = expression.fetch('values', []) |
| 86 | + operator = expression.fetch('operator') |
| 87 | + valid_values = values.is_a?(Array) && values.all? { |v| label_value?(v) } |
| 88 | + valid_values &&= %w[In NotIn].include?(operator) ? !values.empty? : (%w[Exists DoesNotExist].include?(operator) && values.empty?) |
| 89 | + abort "external policy #{name}: invalid selector expression" unless label_key?(key) && valid_values |
| 90 | + matches = case operator |
| 91 | + when 'In' then labels.key?(key) && values.include?(labels[key]) |
| 92 | + when 'NotIn' then !labels.key?(key) || !values.include?(labels[key]) |
| 93 | + when 'Exists' then labels.key?(key) |
| 94 | + when 'DoesNotExist' then !labels.key?(key) |
| 95 | + else false |
| 96 | + end |
| 97 | + abort "external policy #{name}: expression does not match runtime" unless matches |
| 98 | + end |
| 99 | + types = spec['policyTypes'] |
| 100 | + if types.nil? || types.empty? |
| 101 | + types = ['Ingress'] |
| 102 | + types << 'Egress' unless spec.fetch('egress', []).empty? |
| 103 | + end |
| 104 | + abort "external policy #{name}: must isolate ingress and egress" unless %w[Ingress Egress].all? { |t| types.include?(t) } |
| 105 | +end |
| 106 | +# Preserve Helm output byte-for-byte only after every deployment passes. |
| 107 | +STDOUT.write(input) |
0 commit comments