verify.go 11.4 KB
Newer Older
1 2 3 4
package irma

import (
	"time"
5 6

	"github.com/go-errors/errors"
7 8
	"github.com/privacybydesign/gabi"
	"github.com/privacybydesign/gabi/big"
9 10 11 12 13
)

// ProofStatus is the status of the complete proof
type ProofStatus string

14 15 16
// Status is the proof status of a single attribute
type AttributeProofStatus string

17
const (
18
	ProofStatusValid             = ProofStatus("VALID")              // Proof is valid
19
	ProofStatusInvalid           = ProofStatus("INVALID")            // Proof is invalid
20 21 22
	ProofStatusInvalidTimestamp  = ProofStatus("INVALID_TIMESTAMP")  // Attribute-based signature had invalid timestamp
	ProofStatusUnmatchedRequest  = ProofStatus("UNMATCHED_REQUEST")  // Proof does not correspond to a specified request
	ProofStatusMissingAttributes = ProofStatus("MISSING_ATTRIBUTES") // Proof does not contain all requested attributes
23
	ProofStatusExpired           = ProofStatus("EXPIRED")            // Attributes were expired at proof creation time (now, or according to timestamp in case of abs)
24

25 26 27 28 29
	AttributeProofStatusPresent      = AttributeProofStatus("PRESENT")       // Attribute is disclosed and matches the value
	AttributeProofStatusExtra        = AttributeProofStatus("EXTRA")         // Attribute is disclosed, but wasn't requested in request
	AttributeProofStatusMissing      = AttributeProofStatus("MISSING")       // Attribute is NOT disclosed, but should be according to request
	AttributeProofStatusInvalidValue = AttributeProofStatus("INVALID_VALUE") // Attribute is disclosed, but has invalid value according to request
)
30

31 32 33 34 35
// DisclosedAttribute represents a disclosed attribute.
type DisclosedAttribute struct {
	Value      TranslatedString        `json:"value"` // Value of the disclosed attribute
	Identifier AttributeTypeIdentifier `json:"id"`
	Status     AttributeProofStatus    `json:"status"`
36 37
}

38 39
// ProofList is a gabi.ProofList with some extra methods.
type ProofList gabi.ProofList
40

41 42
var ErrorMissingPublicKey = errors.New("Missing public key")

43
// ExtractPublicKeys returns the public keys of each proof in the proofList, in the same order,
44 45
// for later use in verification of the proofList. If one of the proofs is not a ProofD
// an error is returned.
46
func (pl ProofList) ExtractPublicKeys(configuration *Configuration) ([]*gabi.PublicKey, error) {
47
	var publicKeys = make([]*gabi.PublicKey, 0, len(pl))
48

49
	for _, v := range pl {
50 51 52 53 54 55 56 57
		switch v.(type) {
		case *gabi.ProofD:
			proof := v.(*gabi.ProofD)
			metadata := MetadataFromInt(proof.ADisclosed[1], configuration) // index 1 is metadata attribute
			publicKey, err := metadata.PublicKey()
			if err != nil {
				return nil, err
			}
58 59 60
			if publicKey == nil {
				return nil, ErrorMissingPublicKey
			}
61 62
			publicKeys = append(publicKeys, publicKey)
		default:
63
			return nil, errors.New("Cannot extract public key, not a disclosure proofD")
64 65 66 67 68
		}
	}
	return publicKeys, nil
}

69
// VerifyProofs verifies the proofs cryptographically.
70
func (pl ProofList) VerifyProofs(configuration *Configuration, context *big.Int, nonce *big.Int, publickeys []*gabi.PublicKey, isSig bool) (bool, error) {
71 72 73 74
	if publickeys == nil {
		var err error
		publickeys, err = pl.ExtractPublicKeys(configuration)
		if err != nil {
75
			return false, err
76 77 78 79
		}
	}

	if len(pl) != len(publickeys) {
80
		return false, errors.New("Insufficient public keys to verify the proofs")
81
	}
82

83 84 85
	// Compute slice to inform gabi of which proofs should be verified to share the same secret key
	keyshareServers := make([]string, len(pl))
	for i := range pl {
86 87
		schemeID := NewIssuerIdentifier(publickeys[i].Issuer).SchemeManagerIdentifier()
		if !configuration.SchemeManagers[schemeID].Distributed() {
88
			keyshareServers[i] = "." // dummy value: no IRMA scheme will ever have this name
89
		} else {
90
			keyshareServers[i] = schemeID.Name()
91 92 93
		}
	}

94
	return gabi.ProofList(pl).Verify(publickeys, context, nonce, isSig, keyshareServers), nil
95
}
96

97 98
// Expired returns true if any of the contained disclosure proofs is specified at the specified time,
// or now, when the specified time is nil.
99
func (pl ProofList) Expired(configuration *Configuration, t *time.Time) bool {
100 101 102 103 104 105 106
	if t == nil {
		temp := time.Now()
		t = &temp
	}
	for _, proof := range pl {
		proofd, ok := proof.(*gabi.ProofD)
		if !ok {
107
			continue
108 109 110
		}
		metadata := MetadataFromInt(proofd.ADisclosed[1], configuration) // index 1 is metadata attribute
		if metadata.Expiry().Before(*t) {
111
			return true
112 113
		}
	}
114
	return false
115 116
}

117 118 119 120 121
// DisclosedAttributes returns a slice containing the disclosed attributes that are present in the proof list.
// If a non-empty and non-nil AttributeDisjunctionList is included, then the first attributes in the returned slice match
// with the disjunction list in the disjunction list. If any of the given disjunctions is not matched by one
// of the disclosed attributes, then the corresponding item in the returned slice has status AttributeProofStatusMissing.
// The first return parameter of this function indicates whether or not all disjunctions (if present) are satisfied.
122
func (d *Disclosure) DisclosedAttributes(configuration *Configuration, disjunctions AttributeDisjunctionList) (bool, []*DisclosedAttribute, error) {
123 124 125 126 127 128
	return ProofList(d.Proofs).DisclosedAttributes(configuration, disjunctions)

	// TODO new verification logic that uses d.Indices
}

func (pl ProofList) DisclosedAttributes(configuration *Configuration, disjunctions AttributeDisjunctionList) (bool, []*DisclosedAttribute, error) {
129
	var list []*DisclosedAttribute
130 131 132 133 134 135
	list = make([]*DisclosedAttribute, len(disjunctions))
	for i := range list {
		// Populate list with AttributeProofStatusMissing; if an attribute that satisfies a disjunction
		// is found below, the corresponding entry in the list is overwritten
		list[i] = &DisclosedAttribute{
			Status: AttributeProofStatusMissing,
136 137 138
		}
	}

139 140 141
	// Temp slice for attributes that have not yet been matched to one of the disjunctions of the request
	// When we are done matching disclosed attributes against the request, filling the first few slots of list,
	// we append these to list just before returning
142
	extraAttrs := map[AttributeTypeIdentifier]*DisclosedAttribute{}
143

144
	for _, proof := range pl {
145 146 147 148 149 150 151 152 153 154 155
		proofd, ok := proof.(*gabi.ProofD)
		if !ok {
			continue
		}
		metadata := MetadataFromInt(proofd.ADisclosed[1], configuration) // index 1 is metadata attribute
		credtype := metadata.CredentialType()
		if credtype == nil {
			return false, nil, errors.New("ProofList contained a disclosure proof of an unkown credential type")
		}

		for k, v := range proofd.ADisclosed {
156 157
			if k == 0 {
				continue // Should never be disclosed, but skip it to be sure
158 159
			}

160 161 162 163 164 165 166 167
			var attrid AttributeTypeIdentifier
			var attrval *string
			var attr *DisclosedAttribute
			if k == 1 {
				attrid = NewAttributeTypeIdentifier(credtype.Identifier().String())
				p := "present"
				attrval = &p
			} else {
168
				attrid = credtype.AttributeTypes[k-2].GetAttributeTypeIdentifier()
169 170 171
				attrval = decodeAttribute(v, metadata.Version())
			}
			attr = &DisclosedAttribute{
172
				Value:      translateAttribute(attrval),
173 174 175
				Identifier: attrid,
				Status:     AttributeProofStatusExtra,
			}
176

177
			if k > 1 { // Never add metadata (i.e. no-attribute disclosure) as extra
178 179
				extraAttrs[attrid] = attr
			}
180
			if len(disjunctions) == 0 {
181 182
				continue
			}
183 184 185 186

			// See if the current attribute satisfies one of the disjunctions, if so, delete it from extraAttrs
			for i, disjunction := range disjunctions {
				if disjunction.attemptSatisfy(attrid, attrval) {
187 188 189 190 191 192 193 194 195
					if disjunction.satisfied() {
						attr.Status = AttributeProofStatusPresent
					} else {
						attr.Status = AttributeProofStatusInvalidValue
					}
					list[i] = attr
					delete(extraAttrs, attrid)
				}
			}
196 197 198
		}
	}

199
	// Any attributes still in here do not satisfy any of the specified disjunctions; append them now
200 201
	for _, attr := range extraAttrs {
		list = append(list, attr)
202 203
	}

204
	return len(disjunctions) == 0 || disjunctions.satisfied(), list, nil
205 206
}

207
func (d *Disclosure) VerifyAgainstDisjunctions(
208 209 210 211 212
	configuration *Configuration,
	required AttributeDisjunctionList,
	context, nonce *big.Int,
	publickeys []*gabi.PublicKey,
	issig bool,
213
) ([]*DisclosedAttribute, ProofStatus, error) {
214
	// Cryptographically verify the IRMA disclosure proofs in the signature
215
	valid, err := ProofList(d.Proofs).VerifyProofs(configuration, context, nonce, publickeys, issig)
216 217
	if !valid || err != nil {
		return nil, ProofStatusInvalid, err
218 219 220
	}

	// Next extract the contained attributes from the proofs, and match them to the signature request if present
221
	allmatched, list, err := d.DisclosedAttributes(configuration, required)
222
	if err != nil {
223
		return nil, ProofStatusInvalid, err
224 225 226 227
	}

	// Return MISSING_ATTRIBUTES as proofstatus if one of the disjunctions in the request (if present) is not satisfied
	if !allmatched {
228 229 230 231 232 233
		return list, ProofStatusMissingAttributes, nil
	}

	return list, ProofStatusValid, nil
}

234 235
func (d *Disclosure) Verify(configuration *Configuration, request *DisclosureRequest) ([]*DisclosedAttribute, ProofStatus, error) {
	list, status, err := d.VerifyAgainstDisjunctions(configuration, request.Content, request.Context, request.Nonce, nil, false)
236 237
	if err != nil {
		return list, status, err
238
	}
239

240
	now := time.Now()
241
	if expired := ProofList(d.Proofs).Expired(configuration, &now); expired {
242
		return list, ProofStatusExpired, nil
243
	}
244

245
	return list, status, nil
246 247
}

248 249 250 251 252 253 254 255 256
// Verify the attribute-based signature, optionally against a corresponding signature request. If the request is present
// (i.e. not nil), then the first attributes in the returned result match with the disjunction list in the request
// (that is, the i'th attribute in the result should satisfy the i'th disjunction in the request). If the request is not
// fully satisfied in this fasion, the Status of the result is ProofStatusMissingAttributes. Any remaining attributes
// (i.e. not asked for by the request) are also included in the result, after the attributes that match disjunctions
// in the request.
//
// The signature request is optional; if it is nil then the attribute-based signature is still verified, and all
// containing attributes returned in the result.
257
func (sm *SignedMessage) Verify(configuration *Configuration, request *SignatureRequest) ([]*DisclosedAttribute, ProofStatus, error) {
258
	var message string
259

260
	// First check if this signature matches the request
261 262 263
	if request != nil {
		request.Timestamp = sm.Timestamp
		if !sm.MatchesNonceAndContext(request) {
264
			return nil, ProofStatusUnmatchedRequest, nil
265
		}
266 267 268 269 270
		// If there is a request, then the signed message must be that of the request
		message = request.Message
	} else {
		// If not, we just verify that the signed message is a valid signature over its contained message
		message = sm.Message
271 272 273
	}

	// Verify the timestamp
274
	if sm.Timestamp != nil {
275
		if err := sm.VerifyTimestamp(message, configuration); err != nil {
276
			return nil, ProofStatusInvalidTimestamp, nil
277
		}
278 279
	}

280
	// Now, cryptographically verify the IRMA disclosure proofs in the signature
281
	var required AttributeDisjunctionList
282
	if request != nil {
283
		required = request.Content
284
	}
285
	result, status, err := sm.Disclosure().VerifyAgainstDisjunctions(configuration, required, sm.Context, sm.GetNonce(), nil, true)
286 287
	if status != ProofStatusValid || err != nil {
		return result, status, err
288 289
	}

290
	// Check if a credential is expired
291 292 293 294
	var t time.Time
	if sm.Timestamp != nil {
		t = time.Unix(sm.Timestamp.Time, 0)
	}
295
	if expired := ProofList(sm.Signature).Expired(configuration, &t); expired {
296 297
		// The ABS contains attributes that were expired at the time of creation of the ABS.
		return result, ProofStatusExpired, nil
298 299
	}

300
	// All disjunctions satisfied and nothing expired, proof is valid!
301
	return result, ProofStatusValid, nil
302
}