| 1 | package release |
| 2 | |
| 3 | import ( |
| 4 | "crypto/ed25519" |
| 5 | "encoding/base64" |
| 6 | "encoding/json" |
| 7 | "strings" |
| 8 | "testing" |
| 9 | "time" |
| 10 | ) |
| 11 | |
| 12 | // legacyPointer is ChannelPointer exactly as every binary before #253 knows |
| 13 | // it. An old binary decodes into this and nothing else. |
| 14 | type legacyPointer struct { |
| 15 | Schema int `json:"schema"` |
| 16 | Account string `json:"account,omitempty"` |
| 17 | App string `json:"app"` |
| 18 | Channel string `json:"channel"` |
| 19 | Version string `json:"version"` |
| 20 | PromotedAt time.Time `json:"promoted_at"` |
| 21 | History []string `json:"history,omitempty"` |
| 22 | Audit []Promotion `json:"audit,omitempty"` |
| 23 | FastTrack bool `json:"fast_track,omitempty"` |
| 24 | } |
| 25 | |
| 26 | func signedPointerBytes(t *testing.T, priv ed25519.PrivateKey, p *ChannelPointer) []byte { |
| 27 | t.Helper() |
| 28 | b, err := signPointer(RootSigner(priv), p) |
| 29 | if err != nil { |
| 30 | t.Fatalf("signPointer: %v", err) |
| 31 | } |
| 32 | return b |
| 33 | } |
| 34 | |
| 35 | var ( |
| 36 | dA = ManifestDigest([]byte("manifest a")) |
| 37 | dB = ManifestDigest([]byte("manifest b")) |
| 38 | ) |
| 39 | |
| 40 | func TestDigestOf(t *testing.T) { |
| 41 | p := &ChannelPointer{Version: "v3", Digest: dA, History: []string{"v2", "v1"}, HistoryDigests: []string{"", dB}} |
| 42 | for v, want := range map[string]string{"v3": dA, "v2": "", "v1": dB, "v9": ""} { |
| 43 | if got := p.DigestOf(v); got != want { |
| 44 | t.Errorf("DigestOf(%s) = %q, want %q", v, got, want) |
| 45 | } |
| 46 | } |
| 47 | if !p.CarriesDigests() || !p.ChannelHasDigests() { |
| 48 | t.Fatal("a pointer with a head digest carries digests") |
| 49 | } |
| 50 | tail := &ChannelPointer{Version: "v3", History: []string{"v2"}, HistoryDigests: []string{dB}} |
| 51 | if tail.CarriesDigests() || !tail.ChannelHasDigests() { |
| 52 | t.Fatal("history digests alone: the channel has digests, the pointer carries none") |
| 53 | } |
| 54 | if (&ChannelPointer{Version: "v1"}).ChannelHasDigests() { |
| 55 | t.Fatal("a legacy pointer has no digests") |
| 56 | } |
| 57 | var nilp *ChannelPointer |
| 58 | if nilp.DigestOf("v1") != "" { |
| 59 | t.Fatal("a nil pointer DigestOf returns empty string") |
| 60 | } |
| 61 | if nilp.CarriesDigests() { |
| 62 | t.Fatal("a nil pointer CarriesDigests returns false") |
| 63 | } |
| 64 | if nilp.ChannelHasDigests() { |
| 65 | t.Fatal("a nil pointer ChannelHasDigests returns false") |
| 66 | } |
| 67 | } |
| 68 | |
| 69 | // Spec §8: an old binary verifies a pointer with digests. |
| 70 | func TestAnOldBinaryVerifiesAPointerWithDigests(t *testing.T) { |
| 71 | priv, pub := testKeys(t) |
| 72 | wire := signedPointerBytes(t, priv, &ChannelPointer{Account: "bab", App: "km", Channel: "stable", Version: "v2", |
| 73 | Digest: dA, History: []string{"v1"}, HistoryDigests: []string{dB}}) |
| 74 | var sw signedWrapper |
| 75 | if err := json.Unmarshal(wire, &sw); err != nil { |
| 76 | t.Fatal(err) |
| 77 | } |
| 78 | sig, _ := base64.StdEncoding.DecodeString(sw.Sig) |
| 79 | if !ed25519.Verify(pub, []byte(sw.Payload), sig) { |
| 80 | t.Fatal("the signature does not cover the payload as an old binary reads it") |
| 81 | } |
| 82 | payload, _ := base64.StdEncoding.DecodeString(sw.Payload) |
| 83 | var old legacyPointer |
| 84 | if err := json.Unmarshal(payload, &old); err != nil || old.Version != "v2" || len(old.History) != 1 { |
| 85 | t.Fatalf("old decode = %+v, %v", old, err) |
| 86 | } |
| 87 | } |
| 88 | |
| 89 | func TestAPointerWithoutDigestsMarshalsAsBefore(t *testing.T) { |
| 90 | b, err := json.Marshal(&ChannelPointer{Schema: 1, App: "km", Channel: "stable", Version: "v1", History: []string{"v0"}}) |
| 91 | if err != nil { |
| 92 | t.Fatal(err) |
| 93 | } |
| 94 | if strings.Contains(string(b), "digest") { |
| 95 | t.Fatalf("an empty digest leaked into the payload: %s", b) |
| 96 | } |
| 97 | } |
| 98 | |
| 99 | // Review Focus 1. |
| 100 | func TestValidatePointerRefusesMisalignedHistoryDigests(t *testing.T) { |
| 101 | base := func() *ChannelPointer { |
| 102 | return &ChannelPointer{Schema: 1, Account: "bab", App: "km", Channel: "stable", Version: "v3", |
| 103 | PromotedAt: time.Now().UTC().Truncate(time.Second), History: []string{"v2", "v1"}} |
| 104 | } |
| 105 | ok := base() |
| 106 | ok.Digest, ok.HistoryDigests = dA, []string{"", dB} |
| 107 | if err := validatePointer(ok, "bab", "km", "stable"); err != nil { |
| 108 | t.Fatalf("aligned: %v", err) |
| 109 | } |
| 110 | short := base() |
| 111 | short.Digest, short.HistoryDigests = dA, []string{dB} |
| 112 | if err := validatePointer(short, "bab", "km", "stable"); err == nil { |
| 113 | t.Fatal("history_digests shorter than history was accepted") |
| 114 | } |
| 115 | bad := base() |
| 116 | bad.Digest = "not-a-digest" |
| 117 | if err := validatePointer(bad, "bab", "km", "stable"); err == nil { |
| 118 | t.Fatal("a malformed head digest was accepted") |
| 119 | } |
| 120 | badHist := base() |
| 121 | badHist.HistoryDigests = []string{"", strings.ToUpper(dB)} |
| 122 | if err := validatePointer(badHist, "bab", "km", "stable"); err == nil { |
| 123 | t.Fatal("a malformed history digest was accepted") |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | func TestVerifyPointerRoundTripsDigests(t *testing.T) { |
| 128 | priv, pub := testKeys(t) |
| 129 | wire := signedPointerBytes(t, priv, &ChannelPointer{Account: "bab", App: "km", Channel: "stable", Version: "v2", |
| 130 | Digest: dA, History: []string{"v1"}, HistoryDigests: []string{""}}) |
| 131 | p, err := verifyPointer(pub, wire, "bab", "km", "stable") |
| 132 | if err != nil || p.Digest != dA || len(p.HistoryDigests) != 1 || p.HistoryDigests[0] != "" { |
| 133 | t.Fatalf("verifyPointer = %+v, %v", p, err) |
| 134 | } |
| 135 | } |
| 136 | |
amadan