Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Issuer Replace Either By Union Type #1374

Merged
merged 1 commit into from
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ case class StatusListCredential(
`type`: Set[String],
@description(annotations.issuer.description)
@encodedExample(annotations.issuer.example)
issuer: Either[String, CredentialIssuer],
issuer: String | CredentialIssuer,
@description(annotations.id.description)
@encodedExample(annotations.id.example)
id: String,
Expand Down Expand Up @@ -156,11 +156,18 @@ object StatusListCredential {
given credentialIssuerDecoder: JsonDecoder[CredentialIssuer] =
DeriveJsonDecoder.gen[CredentialIssuer]

given eitherStringOrCredentialIssuerEncoder: JsonEncoder[Either[String, CredentialIssuer]] =
JsonEncoder[String].orElseEither(JsonEncoder[CredentialIssuer])
given stringOrCredentialIssuerEncoder: JsonEncoder[String | CredentialIssuer] =
JsonEncoder[String]
.orElseEither(JsonEncoder[CredentialIssuer])
.contramap[String | CredentialIssuer] {
case string: String => Left(string)
case credentialIssuer: CredentialIssuer => Right(credentialIssuer)
}

given eitherStringOrCredentialIssuerDecoder: JsonDecoder[Either[String, CredentialIssuer]] =
JsonDecoder[CredentialIssuer].map(Right(_)).orElse(JsonDecoder[String].map(Left(_)))
given stringOrCredentialIssuerDecoder: JsonDecoder[String | CredentialIssuer] =
JsonDecoder[CredentialIssuer]
.map(issuer => issuer: String | CredentialIssuer)
.orElse(JsonDecoder[String].map(schemaId => schemaId: String | CredentialIssuer))

given statusListCredentialEncoder: JsonEncoder[StatusListCredential] =
DeriveJsonEncoder.gen[StatusListCredential]
Expand All @@ -180,6 +187,16 @@ object StatusListCredential {

given credentialIssuerSchema: Schema[CredentialIssuer] = Schema.derived

given schemaIssuer: Schema[String | CredentialIssuer] = Schema
.schemaForEither(Schema.schemaForString, Schema.derived[CredentialIssuer])
.map[String | CredentialIssuer] {
case Left(string) => Some(string)
case Right(credentialIssuer) => Some(credentialIssuer)
} {
case string: String => Left(string)
case credentialIssuer: CredentialIssuer => Right(credentialIssuer)
}

given statusListCredentialSchema: Schema[StatusListCredential] = Schema.derived

}
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ case class OIDCCredentialIssuerServiceImpl(
`type` = Set(
"VerifiableCredential"
) ++ credentialDefinition.`type`, // TODO: This information should come from Schema registry by record.schemaId
issuer = Left(issuerDid.toString),
issuer = issuerDid.toString,
issuanceDate = Instant.now(),
maybeExpirationDate = None, // TODO: Add expiration date
maybeCredentialSchema = None, // TODO: Add schema from schema registry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ object VcVerificationControllerImplSpec extends ZIOSpecDefault with VcVerificati
`@context` = Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1140,7 +1140,7 @@ class CredentialServiceImpl(
maybeId = None,
`type` =
Set("VerifiableCredential"), // TODO: This information should come from Schema registry by record.schemaId
issuer = Right(CredentialIssuer(jwtIssuer.did.toString, `type` = "Profile")),
issuer = CredentialIssuer(jwtIssuer.did.toString, `type` = "Profile"),
issuanceDate = issuanceDate,
maybeExpirationDate = record.validityPeriod.map(sec => issuanceDate.plusSeconds(sec.toLong)),
maybeCredentialSchema = record.schemaUri.map(id =>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -538,11 +538,9 @@ object CredentialServiceImplSpec extends MockSpecDefault with CredentialServiceS
_ <- holderSvc.receiveCredentialIssue(issueCredential)
} yield assertTrue(
decodedJWT.issuer ==
Right(
CredentialIssuer(
id = decodedJWT.iss,
`type` = "Profile"
)
CredentialIssuer(
id = decodedJWT.iss,
`type` = "Profile"
)
)
}.provideSomeLayer(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -94,7 +94,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -161,7 +161,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -228,7 +228,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -302,7 +302,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -373,7 +373,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -444,7 +444,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -524,7 +524,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -605,7 +605,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -673,7 +673,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -741,7 +741,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down Expand Up @@ -809,7 +809,7 @@ object VcVerificationServiceImplSpec extends ZIOSpecDefault with VcVerificationS
Set("https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1"),
maybeId = Some("http://example.edu/credentials/3732"),
`type` = Set("VerifiableCredential", "UniversityDegreeCredential"),
issuer = Left(issuer.did.toString),
issuer = issuer.did.toString,
issuanceDate = Instant.parse("2010-01-01T00:00:00Z"),
maybeExpirationDate = Some(Instant.parse("2010-01-12T00:00:00Z")),
maybeValidFrom = Some(Instant.parse("2010-01-12T00:00:00Z")),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ object PresentationSubmissionVerificationSpec extends ZIOSpecDefault {
maybeTermsOfUse = None,
maybeValidFrom = None,
maybeValidUntil = None,
maybeIssuer = Some(Left(iss))
maybeIssuer = Some(iss)
),
nbf = jwtCredentialNbf,
aud = Set.empty,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ sealed trait CredentialPayload {

def maybeValidUntil: Option[Instant]

def issuer: Either[String, CredentialIssuer]
def issuer: String | CredentialIssuer

def maybeCredentialStatus: Option[CredentialStatus]

Expand All @@ -93,7 +93,10 @@ sealed trait CredentialPayload {

def toJwtCredentialPayload: JwtCredentialPayload =
JwtCredentialPayload(
iss = issuer.fold(identity, _.id),
iss = issuer match {
case string: String => string
case credentialIssuer: CredentialIssuer => credentialIssuer.id
},
maybeSub = maybeSub,
vc = JwtVc(
`@context` = `@context`,
Expand Down Expand Up @@ -141,7 +144,7 @@ case class JwtVc(
credentialSubject: Json,
maybeValidFrom: Option[Instant],
maybeValidUntil: Option[Instant],
maybeIssuer: Option[Either[String, CredentialIssuer]],
maybeIssuer: Option[String | CredentialIssuer],
maybeCredentialStatus: Option[CredentialStatus],
maybeRefreshService: Option[RefreshService],
maybeEvidence: Option[Json],
Expand All @@ -167,14 +170,14 @@ case class JwtCredentialPayload(
override val credentialSubject = vc.credentialSubject
override val maybeValidFrom = vc.maybeValidFrom
override val maybeValidUntil = vc.maybeValidUntil
override val issuer = vc.maybeIssuer.getOrElse(Left(iss))
override val issuer = vc.maybeIssuer.getOrElse(iss)
}

case class W3cCredentialPayload(
override val `@context`: Set[String],
override val `type`: Set[String],
maybeId: Option[String],
issuer: Either[String, CredentialIssuer],
issuer: String | CredentialIssuer,
issuanceDate: Instant,
maybeExpirationDate: Option[Instant],
override val maybeCredentialSchema: Option[Either[CredentialSchema, List[CredentialSchema]]],
Expand Down Expand Up @@ -236,9 +239,9 @@ object CredentialPayload {
("statusListCredential", credentialStatus.statusListCredential.asJson)
)

implicit val eitherStringOrCredentialIssuerEncoder: Encoder[Either[String, CredentialIssuer]] = {
case Left(value) => Json.fromString(value)
case Right(issuer) => issuer.asJson
implicit val stringOrCredentialIssuerEncoder: Encoder[String | CredentialIssuer] = Encoder.instance {
case string: String => Encoder[String].apply(string)
case credentialIssuer: CredentialIssuer => Encoder[CredentialIssuer].apply(credentialIssuer)
}

implicit val eitherCredentialSchemaOrListEncoder: Encoder[Either[CredentialSchema, List[CredentialSchema]]] = {
Expand Down Expand Up @@ -370,8 +373,10 @@ object CredentialPayload {
)
}

implicit val eitherStringOrCredentialIssuerDecoder: Decoder[Either[String, CredentialIssuer]] =
Decoder[String].map(Left(_)).or(Decoder[CredentialIssuer].map(Right(_)))
implicit val stringOrCredentialIssuerDecoder: Decoder[String | CredentialIssuer] =
Decoder[String]
.map(schema => schema: String | CredentialIssuer)
.or(Decoder[CredentialIssuer].map(schema => schema: String | CredentialIssuer))

implicit val eitherCredentialSchemaOrListDecoder: Decoder[Either[CredentialSchema, List[CredentialSchema]]] =
Decoder[CredentialSchema]
Expand All @@ -390,7 +395,7 @@ object CredentialPayload {
.as[Set[String]]
.orElse(c.downField("type").as[String].map(Set(_)))
maybeId <- c.downField("id").as[Option[String]]
issuer <- c.downField("issuer").as[Either[String, CredentialIssuer]]
issuer <- c.downField("issuer").as[String | CredentialIssuer]
issuanceDate <- c.downField("issuanceDate").as[Instant]
maybeExpirationDate <- c.downField("expirationDate").as[Option[Instant]]
maybeValidFrom <- c.downField("validFrom").as[Option[Instant]]
Expand Down Expand Up @@ -444,7 +449,7 @@ object CredentialPayload {
maybeTermsOfUse <- c.downField("termsOfUse").as[Option[Json]]
maybeValidFrom <- c.downField("validFrom").as[Option[Instant]]
maybeValidUntil <- c.downField("validUntil").as[Option[Instant]]
maybeIssuer <- c.downField("issuer").as[Option[Either[String, CredentialIssuer]]]
maybeIssuer <- c.downField("issuer").as[Option[String | CredentialIssuer]]
} yield {
JwtVc(
`@context` = `@context`,
Expand Down Expand Up @@ -888,7 +893,12 @@ object W3CCredential {
)(didResolver: DidResolver): IO[String, Validation[String, Unit]] = {
JWTVerification.validateEncodedJwt(payload.proof.jwt, proofPurpose)(didResolver: DidResolver)(claim =>
Validation.fromEither(decode[W3cCredentialPayload](claim).left.map(_.toString))
)(_.issuer.fold(identity, _.id))
)(vc =>
vc.issuer match {
case string: String => string
case credentialIssuer: CredentialIssuer => credentialIssuer.id
}
)
}

def verifyDates(w3cPayload: W3cVerifiableCredentialPayload, leeway: TemporalAmount)(implicit
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ object VCStatusList2021 {
),
maybeId = Some(vcId),
`type` = Set("VerifiableCredential", "StatusList2021Credential"),
issuer = Left(jwtIssuer.did.toString),
issuer = jwtIssuer.did.toString,
issuanceDate = Instant.now,
maybeExpirationDate = None,
maybeCredentialSchema = None,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ object JWTVerificationTest extends ZIOSpecDefault {
maybeValidFrom = Some(validFrom),
maybeValidUntil = Some(validUntil),
maybeIssuer = Some(
if (issuerAsObject) Right(CredentialIssuer(issuer.issuer.did.toString, "Profile"))
else Left(issuer.issuer.did.toString)
if (issuerAsObject) CredentialIssuer(issuer.issuer.did.toString, "Profile")
else issuer.issuer.did.toString
)
),
nbf = jwtCredentialNbf, // ISSUANCE DATE
Expand Down Expand Up @@ -211,8 +211,14 @@ object JWTVerificationTest extends ZIOSpecDefault {
.decodeJwt(jwtCredential)
jwtWithObjectIssuer <- JwtCredential
.decodeJwt(jwtCredentialWithObjectIssuer)
jwtWithObjectIssuerIssuer = jwtWithObjectIssuer.vc.maybeIssuer.get.toOption.get.id
jwtIssuer = jwt.vc.maybeIssuer.get.left.toOption.get
jwtWithObjectIssuerIssuer = jwtWithObjectIssuer.vc.maybeIssuer.get match {
case string: String => string
case credentialIssuer: CredentialIssuer => credentialIssuer.id
}
jwtIssuer = jwt.vc.maybeIssuer.get match {
case string: String => string
case credentialIssuer: CredentialIssuer => credentialIssuer.id
}
} yield assertTrue(
jwtWithObjectIssuerIssuer.equals(jwtIssuer)
)
Expand Down
Loading