1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
|
/*
* ZCrypto Copyright 2017 Regents of the University of Michigan
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package verifier
import (
"bufio"
"encoding/pem"
"fmt"
"io"
"github.com/zmap/zcertificate"
"github.com/zmap/zcrypto/x509"
)
// subjectAndKeyFingerprint is a SHA256 fingerprint of (public key, subject).
// This is used a key in maps.
type subjectAndKeyFingerprint string
// Graph represents signing relationships between SubjectAndKey tuples. A node
// in the graph is a SubjectAndKey. An edge in the graph is a certificate issued
// by the direct predecessor (tail) to the direct successor (head).
type Graph struct {
nodes []*GraphNode
edges *GraphEdgeSet
nodesBySubjectAndKey map[subjectAndKeyFingerprint]*GraphNode
nodesBySubject map[string][]*GraphNode // indexed by RawSubject
missingIssuerNode map[string]*GraphEdgeSet // indexed by RawIssuer
}
// A GraphNode is a SubjectAndKey
type GraphNode struct {
SubjectAndKey *x509.SubjectAndKey
childrenBySubjectAndKey map[subjectAndKeyFingerprint]*GraphEdgeSet
parentsBySubjectAndKey map[subjectAndKeyFingerprint]*GraphEdgeSet
}
// A GraphEdge is a certificate that joins two SubjectAndKeys.
type GraphEdge struct {
Certificate *x509.Certificate
issuer *GraphNode // this might not always be filled out
child *GraphNode
root bool
}
// A GraphEdgeSet represents a set of edges. Edges are deduplicated by
// certificate fingerprint.
type GraphEdgeSet struct {
edges map[string]*GraphEdge
}
// NewGraph initializes an empty Graph.
func NewGraph() (g *Graph) {
g = new(Graph)
g.edges = NewGraphEdgeSet()
g.nodesBySubjectAndKey = make(map[subjectAndKeyFingerprint]*GraphNode)
g.nodesBySubject = make(map[string][]*GraphNode)
g.missingIssuerNode = make(map[string]*GraphEdgeSet)
return
}
// Nodes returns a slice of all nodes in the graph.
func (g *Graph) Nodes() (out []*GraphNode) {
if g.nodes == nil {
return
}
out = make([]*GraphNode, len(g.nodes))
copy(out, g.nodes)
return
}
// Edges returns all edges in the graph as a slice.
func (g *Graph) Edges() []*GraphEdge {
return g.edges.Edges()
}
// FindEdge returns an edge with a certificate matching the given SHA256
// fingerprint, if it exists. If it does not exist, FindEdge returns nil.
func (g *Graph) FindEdge(fp x509.CertificateFingerprint) *GraphEdge {
return g.edges.FindEdge(fp)
}
// FindNode returns a node with a matching spki_subject_fingerprint to fp, if it
// exists. If it does not exist, FindNode returns nil.
func (g *Graph) FindNode(fp x509.CertificateFingerprint) *GraphNode {
node := g.nodesBySubjectAndKey[subjectAndKeyFingerprint(fp)]
return node
}
// AddCert inserts an edge for c into the graph, and creates nodes as needed.
func (g *Graph) AddCert(c *x509.Certificate) {
sk := c.SubjectAndKey()
skfp := subjectAndKeyFingerprint(sk.Fingerprint)
isNewNode := false
if g.edges.ContainsCertificate(c) {
// This certificate is already represented in the graph.
return
}
// Create a new edge for this certificate.
edge := new(GraphEdge)
edge.Certificate = c
g.edges.addOrPanic(edge)
// Make the node based on this certificates subject (or find it). Connect the
// node to the edge as the successor / head.
node := g.nodesBySubjectAndKey[skfp]
if node == nil {
node = new(GraphNode)
node.SubjectAndKey = sk
node.childrenBySubjectAndKey = make(map[subjectAndKeyFingerprint]*GraphEdgeSet)
node.parentsBySubjectAndKey = make(map[subjectAndKeyFingerprint]*GraphEdgeSet)
g.nodes = append(g.nodes, node)
g.nodesBySubjectAndKey[skfp] = node
s := string(c.RawSubject)
g.nodesBySubject[s] = append(g.nodesBySubject[s], node)
isNewNode = true
}
edge.child = node
// Connect the edge to the graph
//fmt.Fprintf(os.Stderr, "by subject %v\n", g.nodesBySubject)
potentialIssuers, _ := g.nodesBySubject[string(c.RawIssuer)]
for _, potentialIssuerNode := range potentialIssuers {
issuerIdentity := potentialIssuerNode.SubjectAndKey
if err := x509.CheckSignatureFromKey(issuerIdentity.PublicKey, c.SignatureAlgorithm, c.RawTBSCertificate, c.Signature); err != nil {
// If the signature was not valid, this is not an issuer.
continue
}
// The signature from the potential issuer was valid, and the subjects
// match. Therefore, we have found an issuer. We now need to add the edge to
// the graph. However, the graph is actually a multigraph. Two
// SubjectAndKeys can be joined in the same direction multiple times, by
// issuing multiple certificates to the same subject. Find all edges
// corresponding to this issuer signing a certificate with the target
// subject.
edgeSet := potentialIssuerNode.childrenBySubjectAndKey[skfp]
if edgeSet == nil {
edgeSet = NewGraphEdgeSet()
potentialIssuerNode.childrenBySubjectAndKey[skfp] = edgeSet
}
// Add this edge in. It should not already exist due to earlier checks. If
// it prexists, the graph is corrupted.
edge.issuer = potentialIssuerNode
edgeSet.addOrPanic(edge)
// Update the parents of this node
parentSkpf := subjectAndKeyFingerprint(potentialIssuerNode.SubjectAndKey.Fingerprint)
parentSet := node.parentsBySubjectAndKey[parentSkpf]
if parentSet == nil {
parentSet = NewGraphEdgeSet()
node.parentsBySubjectAndKey[parentSkpf] = parentSet
}
parentSet.addOrPanic(edge)
// A certificate can only be one edge. We found it already, so break out of
// the loop.
break
}
// Check if we have a reverse-dangling edge. This might be "patchable" as we
// add more certificates.
if edge.issuer == nil {
rawIssuer := string(c.RawIssuer)
missingIssuerSet := g.missingIssuerNode[rawIssuer]
if missingIssuerSet == nil {
missingIssuerSet = NewGraphEdgeSet()
g.missingIssuerNode[rawIssuer] = missingIssuerSet
}
missingIssuerSet.addOrPanic(edge)
}
// If we added a new node, check if it issued an existing dangling edge.
if !isNewNode {
return
}
potentialOutgoingEdges := g.missingIssuerNode[string(c.RawSubject)]
if potentialOutgoingEdges == nil {
return
}
// Check every edge in the set to see if this node is an issuer.
var fixedUpEdges []*GraphEdge
for _, candidateEdge := range potentialOutgoingEdges.Edges() {
pk := node.SubjectAndKey.PublicKey
candidateCert := candidateEdge.Certificate
if err := x509.CheckSignatureFromKey(pk, candidateCert.SignatureAlgorithm, candidateCert.RawTBSCertificate, candidateCert.Signature); err != nil {
// If the signature was not valid, this node is not an issuer
continue
}
// The signature was valid, so fixup this edge.
candidateEdge.issuer = node
childSubjectAndKeyFingerprint := subjectAndKeyFingerprint(candidateEdge.child.SubjectAndKey.Fingerprint)
edgeSet := node.childrenBySubjectAndKey[childSubjectAndKeyFingerprint]
if edgeSet == nil {
edgeSet = NewGraphEdgeSet()
node.childrenBySubjectAndKey[childSubjectAndKeyFingerprint] = edgeSet
}
edgeSet.addOrPanic(candidateEdge)
// Set the parents of the node
parentSkpf := subjectAndKeyFingerprint(node.SubjectAndKey.Fingerprint)
parentSet := candidateEdge.child.parentsBySubjectAndKey[parentSkpf]
if parentSet == nil {
parentSet = NewGraphEdgeSet()
candidateEdge.child.parentsBySubjectAndKey[parentSkpf] = parentSet
}
parentSet.addOrPanic(candidateEdge)
// Record the edge as fixed so we can remove it from the missingIssuerNode
// map.
fixedUpEdges = append(fixedUpEdges, candidateEdge)
}
// Remove any fixed-up edges from the missingIssuerNode map.
for _, fixedEdge := range fixedUpEdges {
potentialOutgoingEdges.removeEdge(fixedEdge.Certificate.FingerprintSHA256)
}
if potentialOutgoingEdges.Size() == 0 {
potentialOutgoingEdges = nil
delete(g.missingIssuerNode, string(c.RawSubject))
}
}
// AddRoot adges an edge for certificate c, and marks it as a root.
func (g *Graph) AddRoot(c *x509.Certificate) {
g.AddCert(c)
edge := g.edges.FindEdge(c.FingerprintSHA256)
edge.root = true
}
// IsRoot returns true if c is a root in the graph.
func (g *Graph) IsRoot(c *x509.Certificate) bool {
edge := g.FindEdge(c.FingerprintSHA256)
if edge == nil {
return false
}
return edge.root
}
// AppendFromPEM adds any certificates encoded as PEM from r to the graph. If
// root is true, it marks them as roots. It returns the number of certificates
// parsed.
func (g *Graph) AppendFromPEM(r io.Reader, root bool) int {
count := 0
scanner := bufio.NewScanner(r)
scanner.Split(zcertificate.ScannerSplitPEM)
for scanner.Scan() {
p, _ := pem.Decode(scanner.Bytes())
if p == nil {
continue
}
c, err := x509.ParseCertificate(p.Bytes)
if err != nil {
continue
}
g.AddCert(c)
if root {
g.AddRoot(c)
}
count++
}
return count
}
// NewGraphEdgeSet initializes an empty GraphEdgeSet.
func NewGraphEdgeSet() (es *GraphEdgeSet) {
es = new(GraphEdgeSet)
es.edges = make(map[string]*GraphEdge)
return
}
// Edges returns all edges in the set as a slice.
func (es *GraphEdgeSet) Edges() (out []*GraphEdge) {
for _, edge := range es.edges {
out = append(out, edge)
}
return
}
// ContainsCertificate returns true if c is contained in the GraphEdgeSet.
func (es *GraphEdgeSet) ContainsCertificate(c *x509.Certificate) bool {
fp := string(c.FingerprintSHA256)
_, ok := es.edges[fp]
return ok
}
// ContainsEdge returns true if the edge is contained in the GraphEdgeSet.
func (es *GraphEdgeSet) ContainsEdge(edge *GraphEdge) bool {
return es.ContainsCertificate(edge.Certificate)
}
// Size returns the number of edges in the GraphEdgeSet.
func (es *GraphEdgeSet) Size() int {
return len(es.edges)
}
// FindEdge returns an edge matching the certificate fingerprint, if it exists.
// If it does not exist, FindEdge returns nil.
func (es *GraphEdgeSet) FindEdge(fp x509.CertificateFingerprint) *GraphEdge {
edge, _ := es.edges[string(fp)]
return edge
}
// RemoveEdge removes an edge matching the certificate fingerprint, if it
// exists. If it exists, RemoveEdge returns a point to the removed edge. If no
// such edge exists, RemoveEdge does nothing and returns nil.
func (es *GraphEdgeSet) removeEdge(fp x509.CertificateFingerprint) *GraphEdge {
edge, ok := es.edges[string(fp)]
if !ok {
return nil
}
delete(es.edges, string(fp))
return edge
}
// addOrPanic adds the edge to the set, and panics if there is a fingerprint
// collision.
func (es *GraphEdgeSet) addOrPanic(edge *GraphEdge) {
fp := string(edge.Certificate.FingerprintSHA256)
if _, ok := es.edges[fp]; ok {
panicStr := fmt.Sprintf("adding duplicate edge to set: %s", edge.Certificate.FingerprintSHA256.Hex())
panic(panicStr)
}
es.edges[fp] = edge
}
|