SIWEFromCacaoPayloadFormatterTests.swift

import Foundation
@testable import WalletConnectUtils
@testable import WalletConnectSign
import XCTest

class SIWEFromCacaoPayloadFormatterTests: XCTestCase {
    var sut: SIWEFromCacaoPayloadFormatter!
    let address = "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2"

    override func setUp() {
        sut = SIWEFromCacaoPayloadFormatter()
    }

    func testFormatMessage() throws {
        let expectedMessage =
            """
            service.invalid wants you to sign in with your Ethereum account:
            0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

            I accept the ServiceOrg Terms of Service: https://service.invalid/tos

            URI: https://service.invalid/login
            Version: 1
            Chain ID: 1
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            - ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/
            - https://example.com/my-web2-claim.json
            """
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(authPayload: AuthPayload.stub(), account: Account.stub())
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    // MARK: - CAIP-122 Tests

    func testFormatMessageBitcoin() throws {
        let bitcoinAccount = Account("bip122:000000000019d6689c085ae165831e93:1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa")!
        let expectedMessage =
            """
            service.invalid wants you to sign in with your Bitcoin account:
            1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

            I accept the ServiceOrg Terms of Service: https://service.invalid/tos

            URI: https://service.invalid/login
            Version: 1
            Chain ID: 000000000019d6689c085ae165831e93
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            - ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/
            - https://example.com/my-web2-claim.json
            """
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(authPayload: AuthPayload.stub(), account: bitcoinAccount)
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    func testFormatMessageSolana() throws {
        let solanaAccount = Account("solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp:7S3P4HxJpyyigGzodYwHtCxZyUQe9JiBMHyRWXArAaKv")!
        let expectedMessage =
            """
            service.invalid wants you to sign in with your Solana account:
            7S3P4HxJpyyigGzodYwHtCxZyUQe9JiBMHyRWXArAaKv

            I accept the ServiceOrg Terms of Service: https://service.invalid/tos

            URI: https://service.invalid/login
            Version: 1
            Chain ID: 5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            - ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/
            - https://example.com/my-web2-claim.json
            """
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(authPayload: AuthPayload.stub(), account: solanaAccount)
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    func testFormatMessageWithAnyNamespace() throws {
        let cosmosAccount = Account("cosmos:cosmoshub-4:cosmos1abcdefghijklmnopqrstuvwxyz0123456789")!
        let expectedMessage =
            """
            service.invalid wants you to sign in with your Cosmos account:
            cosmos1abcdefghijklmnopqrstuvwxyz0123456789

            I accept the ServiceOrg Terms of Service: https://service.invalid/tos

            URI: https://service.invalid/login
            Version: 1
            Chain ID: cosmoshub-4
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            - ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/
            - https://example.com/my-web2-claim.json
            """
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(authPayload: AuthPayload.stub(), account: cosmosAccount)
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    // MARK: - Existing Tests (Updated for Ethereum)

    func testNilStatement() throws {
        let expectedMessage =
            """
            service.invalid wants you to sign in with your Ethereum account:
            0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2


            URI: https://service.invalid/login
            Version: 1
            Chain ID: 1
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            - ipfs://bafybeiemxf5abjwjbikoz4mc3a3dla6ual3jsgpdr4cjr3oz3evfyavhwq/
            - https://example.com/my-web2-claim.json
            """
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(
            authPayload: AuthPayload.stub(
                requestParams: AuthRequestParams.stub(statement: nil)
            ),
            account: Account.stub())
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    func testNilResources() throws {
        let expectedMessage =
            """
            service.invalid wants you to sign in with your Ethereum account:
            0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

            I accept the ServiceOrg Terms of Service: https://service.invalid/tos

            URI: https://service.invalid/login
            Version: 1
            Chain ID: 1
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            """
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(
            authPayload: AuthPayload.stub(
                requestParams: AuthRequestParams.stub(resources: nil)
            ),
            account: Account.stub())
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    func testResourcesEmptyArray() throws {
        let expectedMessage =
            """
            service.invalid wants you to sign in with your Ethereum account:
            0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

            I accept the ServiceOrg Terms of Service: https://service.invalid/tos

            URI: https://service.invalid/login
            Version: 1
            Chain ID: 1
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            """
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(
            authPayload: AuthPayload.stub(
                requestParams: AuthRequestParams.stub(resources: [])
            ),
            account: Account.stub())
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    func testNilAllOptionalParams() throws {
        let expectedMessage =
            """
            service.invalid wants you to sign in with your Ethereum account:
            0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

            
            URI: https://service.invalid/login
            Version: 1
            Chain ID: 1
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            """
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(
            authPayload: AuthPayload.stub(
                requestParams: AuthRequestParams.stub(statement: nil, resources: nil)
            ),
            account: Account.stub())
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    func testWithValidRecapAndStatement() throws {
        let validRecapUrn = "urn:recap:eyJhdHQiOiB7ImVpcDE1NSI6IHsicmVxdWVzdC9ldGhfc2VuZFRyYW5zYWN0aW9uIjogW10sICJyZXF1ZXN0L3BlcnNvbmFsX3NpZ24iOiBbXX19fQ=="

        let expectedMessage =
            """
            service.invalid wants you to sign in with your Ethereum account:
            0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

            I accept the ServiceOrg Terms of Service: https://service.invalid/tos I further authorize the stated URI to perform the following actions on my behalf: (1) 'request': 'eth_sendTransaction', 'personal_sign' for 'eip155'.

            URI: https://service.invalid/login
            Version: 1
            Chain ID: 1
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            - urn:recap:eyJhdHQiOiB7ImVpcDE1NSI6IHsicmVxdWVzdC9ldGhfc2VuZFRyYW5zYWN0aW9uIjogW10sICJyZXF1ZXN0L3BlcnNvbmFsX3NpZ24iOiBbXX19fQ==
            """


        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(
            authPayload: AuthPayload.stub(
                requestParams: AuthRequestParams.stub(resources: [validRecapUrn])
            ),
            account: Account.stub())
        let message = try sut.formatMessage(from: cacaoPayload)

        XCTAssertEqual(message, expectedMessage)
    }

    func testWithValidRecapAndNoStatement() throws {
        let validRecapUrn = "urn:recap:eyJhdHQiOiB7ImVpcDE1NSI6IHsicmVxdWVzdC9ldGhfc2VuZFRyYW5zYWN0aW9uIjogW10sICJyZXF1ZXN0L3BlcnNvbmFsX3NpZ24iOiBbXX19fQ=="

        let expectedMessage =
            """
            service.invalid wants you to sign in with your Ethereum account:
            0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

            I further authorize the stated URI to perform the following actions on my behalf: (1) 'request': 'eth_sendTransaction', 'personal_sign' for 'eip155'.

            URI: https://service.invalid/login
            Version: 1
            Chain ID: 1
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            - urn:recap:eyJhdHQiOiB7ImVpcDE1NSI6IHsicmVxdWVzdC9ldGhfc2VuZFRyYW5zYWN0aW9uIjogW10sICJyZXF1ZXN0L3BlcnNvbmFsX3NpZ24iOiBbXX19fQ==
            """

        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(
            authPayload: AuthPayload.stub(
                requestParams: AuthRequestParams.stub(statement: nil, resources: [validRecapUrn])
            ),
            account: Account.stub())
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    func testWithSignAndNotifyRecaps() throws {
        let recap1 = "urn:recap:ewogICAiYXR0Ijp7CiAgICAgICJlaXAxNTUiOnsKICAgICAgICAgInJlcXVlc3QvZXRoX3NlbmRUcmFuc2FjdGlvbiI6IFt7fV0sCiAgICAgICAgICJyZXF1ZXN0L3BlcnNvbmFsX3NpZ24iOiBbe31dCiAgICAgIH0KICAgfQp9"

        let recap2 = "urn:recap:ewogICAiYXR0Ijp7CiAgICAgICJodHRwczovL25vdGlmeS53YWxsZXRjb25uZWN0LmNvbS9hbGwtYXBwcyI6ewogICAgICAgICAiY3J1ZC9ub3RpZmljYXRpb25zIjogW3t9XSwKICAgICAgICAgImNydWQvc3Vic2NyaXB0aW9ucyI6IFt7fV0KICAgICAgfQogICB9Cn0"

        let expectedMessage =
            """
            service.invalid wants you to sign in with your Ethereum account:
            0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

            I further authorize the stated URI to perform the following actions on my behalf: (1) 'request': 'eth_sendTransaction', 'personal_sign' for 'eip155'. (2) 'crud': 'notifications', 'subscriptions' for 'https://notify.walletconnect.com/all-apps'.

            URI: https://service.invalid?walletconnect_notify_key=did:key:z6MktW4hKdsvcXgt9wXmYbSD5sH4NCk5GmNZnokP9yh2TeCf
            Version: 1
            Chain ID: 1
            Nonce: 32891756
            Issued At: 2021-09-30T16:25:24Z
            Resources:
            - urn:recap:eyJhdHQiOnsiZWlwMTU1Ijp7InJlcXVlc3RcL2V0aF9zZW5kVHJhbnNhY3Rpb24iOlt7fV0sInJlcXVlc3RcL3BlcnNvbmFsX3NpZ24iOlt7fV19LCJodHRwczpcL1wvbm90aWZ5LndhbGxldGNvbm5lY3QuY29tXC9hbGwtYXBwcyI6eyJjcnVkXC9ub3RpZmljYXRpb25zIjpbe31dLCJjcnVkXC9zdWJzY3JpcHRpb25zIjpbe31dfX19
            """


        let uri = "https://service.invalid?walletconnect_notify_key=did:key:z6MktW4hKdsvcXgt9wXmYbSD5sH4NCk5GmNZnokP9yh2TeCf"
        let cacaoPayload = try CacaoPayloadBuilder.makeCacaoPayload(
            authPayload: AuthPayload.stub(
                requestParams: AuthRequestParams.stub(uri: uri, statement: nil, resources: [recap1, recap2])
            ),
            account: Account.stub())
        let message = try sut.formatMessage(from: cacaoPayload)
        XCTAssertEqual(message, expectedMessage)
    }

    // MARK: - EIP-4361 single-line field integrity

    func testRejectsDomainWithEmbeddedNewline() throws {
        let payload = try smugglingPayload(domain: "service.invalid\nURI: https://evil.invalid")
        XCTAssertThrowsError(try sut.formatMessage(from: payload)) { error in
            XCTAssertEqual(
                error as? SIWEFromCacaoPayloadFormatter.Errors,
                .invalidSingleLineField("domain")
            )
        }
    }

    func testRejectsStatementWithEmbeddedCarriageReturn() throws {
        let payload = try smugglingPayload(statement: "I accept\rURI: https://evil.invalid")
        XCTAssertThrowsError(try sut.formatMessage(from: payload)) { error in
            XCTAssertEqual(
                error as? SIWEFromCacaoPayloadFormatter.Errors,
                .invalidSingleLineField("statement")
            )
        }
    }

    func testRejectsAudWithEmbeddedNewline() throws {
        let payload = try smugglingPayload(aud: "https://service.invalid/login\nNonce: forged")
        XCTAssertThrowsError(try sut.formatMessage(from: payload)) { error in
            XCTAssertEqual(
                error as? SIWEFromCacaoPayloadFormatter.Errors,
                .invalidSingleLineField("aud")
            )
        }
    }

    private func smugglingPayload(
        domain: String = "service.invalid",
        aud: String = "https://service.invalid/login",
        statement: String? = "I accept the ServiceOrg Terms of Service: https://service.invalid/tos"
    ) throws -> CacaoPayload {
        let account = Account.stub()
        return CacaoPayload(
            iss: account.did,
            domain: domain,
            aud: aud,
            version: "1",
            nonce: "32891756",
            iat: "2021-09-30T16:25:24Z",
            nbf: nil,
            exp: nil,
            statement: statement,
            requestId: nil,
            resources: nil
        )
    }
}