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

import (
	"math/big"
	"time"
6 7 8

	"github.com/go-errors/errors"
	"github.com/mhe/gabi"
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 24

	// The contained attributes are currently expired, but it is not certain if they already were expired
25
	// during creation of the attribute-based signature.
26
	ProofStatusExpired = ProofStatus("EXPIRED")
27

28 29 30 31 32
	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
)
33

34 35 36 37
// VerificationResult is a result of verification of a SignedMessage or disclosure proof, containing all the disclosed attributes
type VerificationResult struct {
	Attributes []*DisclosedAttribute
	Status     ProofStatus
38 39
}

40 41 42 43 44
// 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"`
45 46
}

47 48
// ProofList is a gabi.ProofList with some extra methods.
type ProofList gabi.ProofList
49

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

56
	for _, v := range pl {
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
		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
			}
			publicKeys = append(publicKeys, publicKey)
		default:
			return nil, errors.New("Cannot extract public key, not a disclosure proofD!")
		}
	}
	return publicKeys, nil
}

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

	if len(pl) != len(publickeys) {
84
		return false
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

	// If the secret key comes from a credential whose scheme manager has a keyshare server,
	// then the secretkey = userpart + keysharepart.
	// So, we can only expect two secret key responses to be equal if their credentials
	// are both associated to either no keyshare server, or the same keyshare server.
	// (We have to check this here instead of in gabi, because gabi is unaware of schemes
	// and whether or not they are distributed.)
	secretkeyResponses := make(map[SchemeManagerIdentifier]*big.Int)
	nonKssSchemeID := NewSchemeManagerIdentifier(".") // We use this id for all schemes that don't use a kss
	for i, proof := range pl {
		schemeID := NewIssuerIdentifier(publickeys[i].Issuer).SchemeManagerIdentifier()
		if !configuration.SchemeManagers[schemeID].Distributed() {
			schemeID = nonKssSchemeID
		}
		if response, contains := secretkeyResponses[schemeID]; !contains {
			secretkeyResponses[schemeID] = proof.SecretKeyResponse()
		} else {
			if response.Cmp(proof.SecretKeyResponse()) != 0 {
				return false
			}
		}
	}

	return gabi.ProofList(pl).Verify(publickeys, context, nonce, isSig)
110
}
111

112 113
// Expired returns true if any of the contained disclosure proofs is specified at the specified time,
// or now, when the specified time is nil.
114
func (pl ProofList) Expired(configuration *Configuration, t *time.Time) bool {
115 116 117 118 119 120 121
	if t == nil {
		temp := time.Now()
		t = &temp
	}
	for _, proof := range pl {
		proofd, ok := proof.(*gabi.ProofD)
		if !ok {
122
			continue
123 124 125
		}
		metadata := MetadataFromInt(proofd.ADisclosed[1], configuration) // index 1 is metadata attribute
		if metadata.Expiry().Before(*t) {
126
			return true
127 128
		}
	}
129
	return false
130 131
}

132 133 134 135 136 137
// 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.
func (pl ProofList) DisclosedAttributes(configuration *Configuration, disjunctions AttributeDisjunctionList) (bool, []*DisclosedAttribute, error) {
138
	var list []*DisclosedAttribute
139 140 141 142 143 144
	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,
145 146 147
		}
	}

148 149 150
	// 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
151
	extraAttrs := map[AttributeTypeIdentifier]*DisclosedAttribute{}
152

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
	for _, proof := range pl {
		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 {
			if k < 2 {
				continue // skip metadata attribute
			}

			attrid := credtype.Attributes[k-2].GetAttributeTypeIdentifier()
			attrval := decodeAttribute(v, metadata.Version())
171
			attr := &DisclosedAttribute{
172
				Value:      translateAttribute(attrval),
173 174 175 176
				Identifier: attrid,
				Status:     AttributeProofStatusExtra,
			}
			extraAttrs[attrid] = attr
177
			if len(disjunctions) == 0 {
178 179
				continue
			}
180 181 182 183

			// 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) {
184 185 186 187 188 189 190 191 192
					if disjunction.satisfied() {
						attr.Status = AttributeProofStatusPresent
					} else {
						attr.Status = AttributeProofStatusInvalidValue
					}
					list[i] = attr
					delete(extraAttrs, attrid)
				}
			}
193 194 195
		}
	}

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

201
	return len(disjunctions) == 0 || disjunctions.satisfied(), list, nil
202 203
}

204 205 206 207 208 209 210
func (pl ProofList) VerifyAgainstDisjunctions(
	configuration *Configuration,
	required AttributeDisjunctionList,
	context, nonce *big.Int,
	publickeys []*gabi.PublicKey,
	issig bool,
) ([]*DisclosedAttribute, ProofStatus) {
211
	// Cryptographically verify the IRMA disclosure proofs in the signature
212 213
	if !pl.VerifyProofs(configuration, context, nonce, publickeys, issig) {
		return nil, ProofStatusInvalid
214 215 216 217 218
	}

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

	// Return MISSING_ATTRIBUTES as proofstatus if one of the disjunctions in the request (if present) is not satisfied
	// This status takes priority over 'EXPIRED'
	if !allmatched {
		return list, ProofStatusMissingAttributes
226
	}
227

228 229 230
	now := time.Now()
	if expired := pl.Expired(configuration, &now); expired {
		return list, ProofStatusExpired
231
	}
232

233 234 235
	return list, ProofStatusValid
}

236 237
func (pl ProofList) Verify(configuration *Configuration, request *DisclosureRequest) ([]*DisclosedAttribute, ProofStatus) {
	return pl.VerifyAgainstDisjunctions(configuration, request.Content, request.Context, request.Nonce, nil, false)
238 239
}

240 241 242 243 244 245 246 247 248
// 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.
249
func (sm *SignedMessage) Verify(configuration *Configuration, request *SignatureRequest) ([]*DisclosedAttribute, ProofStatus) {
250
	var message string
251

252
	// First check if this signature matches the request
253 254 255
	if request != nil {
		request.Timestamp = sm.Timestamp
		if !sm.MatchesNonceAndContext(request) {
256
			return nil, ProofStatusUnmatchedRequest
257
		}
258 259 260 261 262
		// 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
263 264 265
	}

	// Verify the timestamp
266
	if sm.Timestamp != nil {
267
		if err := sm.VerifyTimestamp(message, configuration); err != nil {
268
			return nil, ProofStatusInvalidTimestamp
269
		}
270 271
	}

272
	// Now, cryptographically verify the IRMA disclosure proofs in the signature
273 274
	pl := ProofList(sm.Signature)
	var required AttributeDisjunctionList
275
	if request != nil {
276
		required = request.Content
277
	}
278 279 280
	result, status := pl.VerifyAgainstDisjunctions(configuration, required, sm.Context, sm.GetNonce(), nil, true)
	if status != ProofStatusValid {
		return result, status
281 282
	}

283
	// Check if a credential is expired
284 285 286 287
	var t time.Time
	if sm.Timestamp != nil {
		t = time.Unix(sm.Timestamp.Time, 0)
	}
288
	if expired := pl.Expired(configuration, &t); expired {
289
		if sm.Timestamp == nil {
290 291 292
			// At least one of the contained attributes has currently expired. We don't know the
			// creation time of the ABS so we can't ascertain that the attributes were still valid then.
			// Otherwise the signature is valid.
293
			status = ProofStatusExpired
294
		} else {
295 296
			// The ABS contains attributes that were expired at the time of creation of the ABS.
			// This must not happen and in this case the signature is invalid
297
			status = ProofStatusInvalid
298
		}
299
		return result, status
300 301
	}

302
	// All disjunctions satisfied and nothing expired, proof is valid!
303
	return result, ProofStatusValid
304
}