Skip to content

Commit afdf3a5

Browse files
thisisabhashthisisabhash
committed
feat(predictions): add public definitions for no light challenge support (#3617)
* feat(predictions): add public definitions for no light challenge support * Add missing files * fix swiftlint issue * feat(predictions): add implementation for no light support (#3618) * feat(predictions): add implementation for no light support * fix swiftlint issue * address review comments * address review comments * address review comments
1 parent 5fd8464 commit afdf3a5

16 files changed

+356
-72
lines changed

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Events/LivenessEvent.swift

+3-1
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ public enum LivenessEventKind {
2323
self.rawValue = rawValue
2424
}
2525

26-
public static let challenge = Self(rawValue: "ServerSessionInformationEvent")
26+
public static let sessionInformation = Self(rawValue: "ServerSessionInformationEvent")
2727
public static let disconnect = Self(rawValue: "DisconnectionEvent")
28+
public static let challenge = Self(rawValue: "ChallengeEvent")
2829
}
2930
case server(Server)
3031

@@ -60,6 +61,7 @@ extension LivenessEventKind: CustomDebugStringConvertible {
6061
public var debugDescription: String {
6162
switch self {
6263
case .server(.challenge): return ".server(.challenge)"
64+
case .server(.sessionInformation): return ".server(.sessionInformation)"
6365
case .server(.disconnect): return ".server(.disconnect)"
6466
case .client(.initialFaceDetected): return ".client(.initialFaceDetected)"
6567
case .client(.video): return ".client(.video)"

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Events/LivenessFinalCientEvent.swift ‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Events/LivenessFinalClientEvent.swift

+27-6
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ public struct FinalClientEvent {
2626

2727
extension LivenessEvent where T == FinalClientEvent {
2828
@_spi(PredictionsFaceLiveness)
29-
public static func final(event: FinalClientEvent) throws -> Self {
30-
31-
let clientEvent = ClientSessionInformationEvent(
32-
challenge: .init(
33-
faceMovementAndLightChallenge: .init(
29+
public static func final(event: FinalClientEvent,
30+
challenge: Challenge) throws -> Self {
31+
let clientChallengeType: ClientChallenge.ChallengeType
32+
switch challenge.type {
33+
case .faceMovementAndLightChallenge:
34+
clientChallengeType = .faceMovementAndLightChallenge(
35+
challenge: .init(
3436
challengeID: event.initialClientEvent.challengeID,
3537
targetFace: .init(
3638
boundingBox: .init(boundingBox: event.targetFace.initialEvent.boundingBox),
@@ -46,7 +48,26 @@ extension LivenessEvent where T == FinalClientEvent {
4648
videoEndTimeStamp: Date().epochMilliseconds
4749
)
4850
)
49-
)
51+
case .faceMovementChallenge:
52+
clientChallengeType = .faceMovementChallenge(
53+
challenge: .init(
54+
challengeID: event.initialClientEvent.challengeID,
55+
targetFace: .init(
56+
boundingBox: .init(boundingBox: event.targetFace.initialEvent.boundingBox),
57+
faceDetectedInTargetPositionStartTimestamp: event.targetFace.initialEvent.startTimestamp,
58+
faceDetectedInTargetPositionEndTimestamp: event.targetFace.endTimestamp
59+
),
60+
initialFace: .init(
61+
boundingBox: .init(boundingBox: event.initialClientEvent.initialFaceLocation.boundingBox),
62+
initialFaceDetectedTimeStamp: event.initialClientEvent.initialFaceLocation.startTimestamp
63+
),
64+
videoStartTimestamp: nil,
65+
videoEndTimeStamp: Date().epochMilliseconds
66+
)
67+
)
68+
}
69+
70+
let clientEvent = ClientSessionInformationEvent(challenge: .init(clientChallengeType: clientChallengeType))
5071
let payload = try JSONEncoder().encode(clientEvent)
5172
return .init(
5273
payload: payload,

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Events/LivenessFreshnessEvent.swift

+14-12
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,20 @@ extension LivenessEvent where T == FreshnessEvent {
2929
public static func freshness(event: FreshnessEvent) throws -> Self {
3030
let clientEvent = ClientSessionInformationEvent(
3131
challenge: .init(
32-
faceMovementAndLightChallenge: .init(
33-
challengeID: event.challengeID,
34-
targetFace: nil,
35-
initialFace: nil,
36-
videoStartTimestamp: nil,
37-
colorDisplayed: .init(
38-
currentColor: .init(rgb: event.color),
39-
sequenceNumber: event.sequenceNumber,
40-
currentColorStartTimeStamp: event.timestamp,
41-
previousColor: .init(rgb: event.previousColor)
42-
),
43-
videoEndTimeStamp: nil
32+
clientChallengeType: .faceMovementAndLightChallenge(
33+
challenge: .init(
34+
challengeID: event.challengeID,
35+
targetFace: nil,
36+
initialFace: nil,
37+
videoStartTimestamp: nil,
38+
colorDisplayed: .init(
39+
currentColor: .init(rgb: event.color),
40+
sequenceNumber: event.sequenceNumber,
41+
currentColorStartTimeStamp: event.timestamp,
42+
previousColor: .init(rgb: event.previousColor)
43+
),
44+
videoEndTimeStamp: nil
45+
)
4446
)
4547
)
4648
)

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Events/LivenessInitialClientEvent.swift

+23-5
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,20 @@ public struct InitialClientEvent {
2626

2727
extension LivenessEvent where T == InitialClientEvent {
2828
@_spi(PredictionsFaceLiveness)
29-
public static func initialFaceDetected(event: InitialClientEvent) throws -> Self {
29+
public static func initialFaceDetected(
30+
event: InitialClientEvent,
31+
challenge: Challenge
32+
) throws -> Self {
3033
let initialFace = InitialFace(
3134
boundingBox: .init(boundingBox: event.initialFaceLocation.boundingBox),
3235
initialFaceDetectedTimeStamp: event.initialFaceLocation.startTimestamp
3336
)
3437

35-
let clientSessionInformationEvent = ClientSessionInformationEvent(
36-
challenge: .init(
37-
faceMovementAndLightChallenge: .init(
38+
let clientChallengeType: ClientChallenge.ChallengeType
39+
switch challenge.type {
40+
case .faceMovementAndLightChallenge:
41+
clientChallengeType = .faceMovementAndLightChallenge(
42+
challenge: .init(
3843
challengeID: event.challengeID,
3944
targetFace: nil,
4045
initialFace: initialFace,
@@ -43,8 +48,21 @@ extension LivenessEvent where T == InitialClientEvent {
4348
videoEndTimeStamp: nil
4449
)
4550
)
51+
case .faceMovementChallenge:
52+
clientChallengeType = .faceMovementChallenge(
53+
challenge: .init(
54+
challengeID: event.challengeID,
55+
targetFace: nil,
56+
initialFace: initialFace,
57+
videoStartTimestamp: event.videoStartTimestamp,
58+
videoEndTimeStamp: nil
59+
)
60+
)
61+
}
62+
63+
let clientSessionInformationEvent = ClientSessionInformationEvent(
64+
challenge: .init(clientChallengeType: clientChallengeType)
4665
)
47-
4866
let payload = try JSONEncoder().encode(clientSessionInformationEvent)
4967
return .init(
5068
payload: payload,

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Model/DTOMapping.swift

+56-37
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,18 @@
88
import Foundation
99

1010
func ovalChallenge(from event: ServerSessionInformationEvent) -> FaceLivenessSession.OvalMatchChallenge {
11-
let challengeConfig = event.sessionInformation.challenge.faceMovementAndLightChallenge.challengeConfig
12-
let ovalParameters = event.sessionInformation.challenge.faceMovementAndLightChallenge.ovalParameters
11+
let challengeConfig: ChallengeConfig
12+
let ovalParameters: OvalParameters
13+
14+
switch event.sessionInformation.challenge.type {
15+
case .faceMovementAndLightChallenge(let challenge):
16+
challengeConfig = challenge.challengeConfig
17+
ovalParameters = challenge.ovalParameters
18+
case .faceMovementChallenge(let challenge):
19+
challengeConfig = challenge.challengeConfig
20+
ovalParameters = challenge.ovalParameters
21+
}
22+
1323
let ovalBoundingBox = FaceLivenessSession.BoundingBox.init(
1424
x: Double(ovalParameters.centerX - ovalParameters.width / 2),
1525
y: Double(ovalParameters.centerY - ovalParameters.height / 2),
@@ -37,44 +47,46 @@ func ovalChallenge(from event: ServerSessionInformationEvent) -> FaceLivenessSes
3747
)
3848
}
3949

40-
func colorChallenge(from event: ServerSessionInformationEvent) -> FaceLivenessSession.ColorChallenge {
41-
let displayColors = event.sessionInformation.challenge
42-
.faceMovementAndLightChallenge.colorSequences
43-
.map({ color -> FaceLivenessSession.DisplayColor in
50+
func colorChallenge(from event: ServerSessionInformationEvent) -> FaceLivenessSession.ColorChallenge? {
51+
switch event.sessionInformation.challenge.type {
52+
case .faceMovementAndLightChallenge(let challenge):
53+
let displayColors = challenge.colorSequences
54+
.map({ color -> FaceLivenessSession.DisplayColor in
4455

45-
let duration: Double
46-
let shouldScroll: Bool
47-
switch (color.downscrollDuration, color.flatDisplayDuration) {
48-
case (...0, 0...):
49-
duration = Double(color.flatDisplayDuration)
50-
shouldScroll = false
51-
default:
52-
duration = Double(color.downscrollDuration)
53-
shouldScroll = true
54-
}
56+
let duration: Double
57+
let shouldScroll: Bool
58+
switch (color.downscrollDuration, color.flatDisplayDuration) {
59+
case (...0, 0...):
60+
duration = Double(color.flatDisplayDuration)
61+
shouldScroll = false
62+
default:
63+
duration = Double(color.downscrollDuration)
64+
shouldScroll = true
65+
}
5566

56-
precondition(
57-
color.freshnessColor.rgb.count == 3,
58-
"""
59-
Received invalid freshness colors.
60-
Expected 3 values (r, g, b), received: \(color.freshnessColor.rgb.count)
61-
"""
62-
)
67+
precondition(
68+
color.freshnessColor.rgb.count == 3,
69+
"""
70+
Received invalid freshness colors.
71+
Expected 3 values (r, g, b), received: \(color.freshnessColor.rgb.count)
72+
"""
73+
)
6374

64-
return .init(
65-
rgb: .init(
66-
red: Double(color.freshnessColor.rgb[0]) / 255,
67-
green: Double(color.freshnessColor.rgb[1]) / 255,
68-
blue: Double(color.freshnessColor.rgb[2]) / 255,
69-
_values: color.freshnessColor.rgb
70-
),
71-
duration: duration,
72-
shouldScroll: shouldScroll
73-
)
74-
})
75-
return .init(
76-
colors: displayColors
77-
)
75+
return .init(
76+
rgb: .init(
77+
red: Double(color.freshnessColor.rgb[0]) / 255,
78+
green: Double(color.freshnessColor.rgb[1]) / 255,
79+
blue: Double(color.freshnessColor.rgb[2]) / 255,
80+
_values: color.freshnessColor.rgb
81+
),
82+
duration: duration,
83+
shouldScroll: shouldScroll
84+
)
85+
})
86+
return .init(colors: displayColors)
87+
case .faceMovementChallenge:
88+
return nil
89+
}
7890
}
7991

8092
func sessionConfiguration(from event: ServerSessionInformationEvent) -> FaceLivenessSession.SessionConfiguration {
@@ -83,3 +95,10 @@ func sessionConfiguration(from event: ServerSessionInformationEvent) -> FaceLive
8395
ovalMatchChallenge: ovalChallenge(from: event)
8496
)
8597
}
98+
99+
func challengeType(from event: ChallengeEvent) -> Challenge {
100+
.init(
101+
version: event.version,
102+
type: event.type
103+
)
104+
}

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Model/FaceLivenessSession+Challenge.swift

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
//
2+
// Copyright Amazon.com Inc. or its affiliates.
3+
// All Rights Reserved.
4+
//
5+
// SPDX-License-Identifier: Apache-2.0
6+
//
7+
8+
import Foundation
9+
10+
extension FaceLivenessSession {
11+
public static let supportedChallenges: [Challenge] = [
12+
Challenge(version: "2.0.0", type: .faceMovementAndLightChallenge),
13+
Challenge(version: "1.0.0", type: .faceMovementChallenge)
14+
]
15+
}

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Model/FaceLivenessSession+SessionConfiguration.swift

+5-2
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ import Foundation
1010
extension FaceLivenessSession {
1111
@_spi(PredictionsFaceLiveness)
1212
public struct SessionConfiguration {
13-
public let colorChallenge: ColorChallenge
13+
public let colorChallenge: ColorChallenge?
1414
public let ovalMatchChallenge: OvalMatchChallenge
1515

16-
public init(colorChallenge: ColorChallenge, ovalMatchChallenge: OvalMatchChallenge) {
16+
public init(
17+
colorChallenge: ColorChallenge? = nil,
18+
ovalMatchChallenge: OvalMatchChallenge
19+
) {
1720
self.colorChallenge = colorChallenge
1821
self.ovalMatchChallenge = ovalMatchChallenge
1922
}

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/SPI/AWSPredictionsPlugin+Liveness.swift

+12-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ extension AWSPredictionsPlugin {
3636
let session = FaceLivenessSession(
3737
websocket: WebSocketSession(),
3838
signer: signer,
39-
baseURL: url
39+
baseURL: url,
40+
options: options
4041
)
4142

4243
session.onServiceException = { completion(.failure($0)) }
@@ -48,7 +49,16 @@ extension AWSPredictionsPlugin {
4849
extension FaceLivenessSession {
4950
@_spi(PredictionsFaceLiveness)
5051
public struct Options {
51-
public init() {}
52+
public let viewId: String
53+
public let preCheckViewEnabled: Bool
54+
55+
public init(
56+
faceLivenessDetectorViewId: String,
57+
preCheckViewEnabled: Bool
58+
) {
59+
self.viewId = faceLivenessDetectorViewId
60+
self.preCheckViewEnabled = preCheckViewEnabled
61+
}
5262
}
5363
}
5464

‎AmplifyPlugins/Predictions/AWSPredictionsPlugin/Liveness/Service/Challenge.swift

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
//
2+
// Copyright Amazon.com Inc. or its affiliates.
3+
// All Rights Reserved.
4+
//
5+
// SPDX-License-Identifier: Apache-2.0
6+
//
7+
8+
import Foundation
9+
10+
@_spi(PredictionsFaceLiveness)
11+
public struct Challenge {
12+
public let version: String
13+
public let type: ChallengeType
14+
15+
public init(version: String, type: ChallengeType) {
16+
self.version = version
17+
self.type = type
18+
}
19+
20+
public func queryParameterString() -> String {
21+
return self.type.rawValue + "_" + self.version
22+
}
23+
}
24+
25+
@_spi(PredictionsFaceLiveness)
26+
public enum ChallengeType: String, Codable {
27+
case faceMovementChallenge = "FaceMovementChallenge"
28+
case faceMovementAndLightChallenge = "FaceMovementAndLightChallenge"
29+
}

0 commit comments

Comments
 (0)