การตรวจสอบสิทธิ์ในอุปกรณ์ที่สวมใส่ได้: เครื่องมือจัดการข้อมูลเข้าสู่ระบบ

แอป Wear OS สามารถทำงานแบบสแตนด์อโลนได้โดยไม่ต้องมีแอปที่ใช้ร่วมกัน ซึ่งหมายความว่าแอป Wear OS ต้องจัดการการตรวจสอบสิทธิ์ด้วยตนเองเมื่อเข้าถึงข้อมูลจากอินเทอร์เน็ต แต่หน้าจอขนาดเล็กของนาฬิกาและความสามารถในการป้อนข้อมูลที่ลดลงจะจำกัดตัวเลือกการตรวจสอบสิทธิ์ที่แอป Wear OS ใช้ได้

คู่มือนี้จะให้คำแนะนำเกี่ยวกับวิธีการตรวจสอบสิทธิ์ที่แนะนำสำหรับแอป Wear OS ซึ่งก็คือ Credential Manager

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีออกแบบประสบการณ์การลงชื่อเข้าใช้ที่ดีได้ที่คู่มือ UX สำหรับการลงชื่อเข้าใช้

ข้อควรพิจารณาเบื้องต้น

โปรดพิจารณาประเด็นต่อไปนี้ก่อนเริ่มการติดตั้งใช้งาน

โหมดผู้มาเยือน

ไม่ต้องมีการตรวจสอบสิทธิ์สำหรับฟังก์ชันการทำงานทั้งหมด แต่ควรให้ผู้ใช้เข้าถึงฟีเจอร์ต่างๆ ได้มากที่สุดโดยไม่ต้องลงชื่อเข้าใช้

ผู้ใช้อาจค้นพบและติดตั้งแอป Wear ของคุณโดยไม่ได้ใช้แอปบนอุปกรณ์เคลื่อนที่ จึงอาจไม่มีบัญชีและอาจไม่ทราบว่าแอปมีฟีเจอร์อะไรบ้าง ตรวจสอบว่าฟังก์ชันการทำงานของโหมดผู้มาเยือนแสดงฟีเจอร์ของแอปได้อย่างถูกต้อง

อุปกรณ์บางเครื่องอาจปลดล็อกค้างไว้นานกว่าปกติ

ในอุปกรณ์ที่รองรับซึ่งใช้ Wear OS 5 ขึ้นไป ระบบจะตรวจจับว่าผู้ใช้สวมอุปกรณ์บนข้อมือหรือไม่ หากผู้ใช้ปิดการตรวจจับข้อมือแล้วถอดอุปกรณ์ออกจากข้อมือ ระบบจะปลดล็อกอุปกรณ์ไว้เป็นระยะเวลานานกว่าปกติ

หากแอปของคุณต้องการการรักษาความปลอดภัยในระดับที่สูงขึ้น เช่น เมื่อแสดงข้อมูลที่อาจมีความละเอียดอ่อนหรือเป็นข้อมูลส่วนตัว ให้ตรวจสอบก่อนว่าได้เปิดใช้การตรวจจับข้อมือหรือไม่ โดยทำดังนี้

fun isWristDetectionAutoLockingEnabled(context: Context): Boolean {
    // Use the keyguard manager to check for the presence of a lock mechanism
    val keyguardManager = context.getSystemService<KeyguardManager>()
    val isSecured = keyguardManager?.isDeviceSecure == true

    // Use OEM-specific system settings to verify that on-body autolock is enabled.
    val isWristDetectionOn = android.provider.Settings.Global.getInt(
        context.contentResolver, PIXEL_WRIST_AUTOLOCK_SETTING_STATE,
        0
    ) == 1

    return isSecured && isWristDetectionOn
}

หากค่าที่แสดงผลของเมธอดนี้คือ false ให้แจ้งให้ผู้ใช้ลงชื่อเข้าใช้บัญชีในแอปก่อนแสดงเนื้อหาเฉพาะผู้ใช้

Credential Manager

Credential Manager เป็น API ที่แนะนำสำหรับการตรวจสอบสิทธิ์ใน Wear OS ซึ่งจะช่วยให้ผู้ใช้ลงชื่อเข้าใช้แอปพลิเคชัน Wear OS ในสภาพแวดล้อมแบบสแตนด์อโลนได้อย่างปลอดภัยยิ่งขึ้น โดยไม่ต้องใช้โทรศัพท์ที่จับคู่ไว้และไม่ต้องจำรหัสผ่าน

เอกสารนี้สรุปข้อมูลที่นักพัฒนาแอปจำเป็นต้องใช้ในการติดตั้งใช้งานโซลูชัน Credential Manager ด้วยกลไกการตรวจสอบสิทธิ์มาตรฐานที่โฮสต์ ซึ่งได้แก่

  • พาสคีย์
  • รหัสผ่าน
  • ข้อมูลประจำตัวแบบรวมศูนย์ (เช่น ฟีเจอร์ลงชื่อเข้าใช้ด้วย Google)

นอกจากนี้ คู่มือนี้ยังมีคำแนะนำเกี่ยวกับวิธีย้ายข้อมูลวิธีการตรวจสอบสิทธิ์ Wear OS อื่นๆ ที่ยอมรับได้ (การแชร์โทเค็นชั้นข้อมูลและ OAuth) เป็นข้อมูลสำรองสำหรับ Credential Manager และคำแนะนำพิเศษสำหรับการจัดการการเปลี่ยนจากปุ่มลงชื่อเข้าใช้ด้วย Google แบบสแตนด์อโลนที่เลิกใช้งานแล้วไปเป็นเวอร์ชัน Credential Manager แบบฝัง

ข้อจำกัดและความแตกต่างของ Wear OS

นักพัฒนาแอปควรคำนึงถึงข้อจำกัดและความแตกต่างต่อไปนี้ใน Wear OS

  • Credential Manager พร้อมใช้งานใน Wear OS 3 ขึ้นไป
  • สร้างข้อมูลเข้าสู่ระบบใน Wear OS ไม่ได้
  • ระบบไม่รองรับทั้งข้อมูลเข้าสู่ระบบเพื่อกู้คืนและขั้นตอนการลงชื่อเข้าใช้แบบไฮบริด
  • เฉพาะผู้ให้บริการข้อมูลเข้าสู่ระบบที่มีการผสานรวม Wear OS เท่านั้นที่สามารถนำมาใช้ซ้ำจากอุปกรณ์เคลื่อนที่ได้

พาสคีย์ใน Wear OS

เราขอแนะนำอย่างยิ่งให้นักพัฒนาแอปใช้พาสคีย์ในการติดตั้งใช้งาน Credential Manager ของ Wear OS พาสคีย์เป็นมาตรฐานอุตสาหกรรมใหม่สำหรับการตรวจสอบสิทธิ์ผู้ใช้ปลายทาง และมีประโยชน์ที่สำคัญหลายประการสำหรับผู้ใช้

พาสคีย์ใช้งานง่ายกว่า

  • ผู้ใช้สามารถเลือกบัญชีที่จะลงชื่อเข้าใช้ได้ โดยไม่จำเป็นต้องพิมพ์ชื่อผู้ใช้
  • ผู้ใช้สามารถตรวจสอบสิทธิ์โดยใช้การล็อกหน้าจอของอุปกรณ์
  • หลังจากสร้างและลงทะเบียนพาสคีย์แล้ว ผู้ใช้จะเปลี่ยนไปใช้อุปกรณ์ใหม่ได้อย่างราบรื่นและใช้งานได้ทันทีโดยไม่ต้องลงทะเบียนซ้ำ

พาสคีย์ปลอดภัยกว่า

  • นักพัฒนาแอปจะบันทึกเฉพาะคีย์สาธารณะลงในเซิร์ฟเวอร์แทนการบันทึกรหัสผ่าน ซึ่งหมายความว่าผู้ไม่ประสงค์ดีจะแฮ็กเซิร์ฟเวอร์ได้ยากขึ้น และมีข้อมูลที่ต้องล้างน้อยลงมากในกรณีที่มีการละเมิด
  • พาสคีย์ให้การป้องกันที่ต้านทานฟิชชิงได้ พาสคีย์จะทำงานได้บนเว็บไซต์และแอปที่ลงทะเบียนเท่านั้น ผู้ใช้จึงจะไม่ถูกหลอกให้ตรวจสอบสิทธิ์ในเว็บไซต์หลอกลวงเนื่องจากเบราว์เซอร์หรือระบบปฏิบัติการจะจัดการการยืนยัน
  • พาสคีย์ช่วยลดความจำเป็นในการส่ง SMS ทำให้การตรวจสอบสิทธิ์คุ้มค่ามากขึ้น

ใช้พาสคีย์

ซึ่งรวมถึงการตั้งค่าและคำแนะนำสำหรับการติดตั้งใช้งานทุกประเภท

ตั้งค่า

  1. ตั้งค่าระดับ API เป้าหมายเป็น 35 ในไฟล์ build.gradle ของโมดูลแอปพลิเคชัน

    android {
        defaultConfig {
            targetSdk(35)
        }
    }
    
  2. เพิ่มบรรทัดต่อไปนี้ลงในไฟล์ build.gradle สำหรับแอปหรือโมดูล โดยใช้เวอร์ชันเสถียรล่าสุดจากข้อมูลอ้างอิงรุ่น androidx.credentials

    androidx.credentials:credentials:1.6.0
    androidx.credentials:credentials-play-services-auth:1.6.0
    

วิธีการตรวจสอบสิทธิ์ในตัว

เนื่องจาก Credential Manager เป็น API แบบรวม ขั้นตอนการติดตั้งใช้งานสำหรับ Wear OS จึงเหมือนกับอุปกรณ์ประเภทอื่นๆ

ใช้วิธีการสำหรับอุปกรณ์เคลื่อนที่เพื่อเริ่มต้นใช้งานและใช้การรองรับพาสคีย์และรหัสผ่าน

ขั้นตอนในการเพิ่มการรองรับฟีเจอร์ลงชื่อเข้าใช้ด้วย Google ลงใน Credential Manager มุ่งเน้นไปที่การพัฒนาแอปบนอุปกรณ์เคลื่อนที่ แต่ขั้นตอนจะเหมือนกันใน Wear OS

โปรดทราบว่าเนื่องจากคุณไม่สามารถสร้างข้อมูลเข้าสู่ระบบใน Wear OS ได้ คุณจึงไม่จำเป็นต้องใช้วิธีการสร้างข้อมูลเข้าสู่ระบบที่กล่าวถึงในวิธีการสำหรับอุปกรณ์เคลื่อนที่

วิธีการตรวจสอบสิทธิ์สำรอง

วิธีการตรวจสอบสิทธิ์อื่นๆ ที่ยอมรับได้สำหรับแอป Wear OS มี 2 วิธี ได้แก่ OAuth 2.0 (ตัวแปรใดก็ได้) และการแชร์ชั้นข้อมูลโทเค็นการตรวจสอบสิทธิ์บนอุปกรณ์เคลื่อนที่ แม้ว่าวิธีการเหล่านี้จะไม่มีจุดผสานรวมใน Credential Manager API แต่ก็สามารถรวมไว้ในขั้นตอน UX ของ Credential Manager เป็นทางเลือกสำรองในกรณีที่ผู้ใช้ปิดหน้าจอ Credential Manager

หากต้องการจัดการการดำเนินการของผู้ใช้ในการปิดหน้าจอ Credential Manager ให้ตรวจจับ GetCredentialCancellationException เป็นส่วนหนึ่งของตรรกะ GetCredential และไปยัง UI การตรวจสอบสิทธิ์ที่กำหนดเองของคุณเอง

try {
    val getCredentialResponse: GetCredentialResponse =
        credentialManager.getCredential(activity, createGetCredentialRequest())
    return authenticate(getCredentialResponse.credential)
} catch (_: GetCredentialCancellationException) {
    navigateToSecondaryAuthentication()
}

จากนั้น UI การตรวจสอบสิทธิ์ที่กำหนดเองจะแสดงวิธีการตรวจสอบสิทธิ์อื่นๆ ที่ยอมรับได้ซึ่งอธิบายไว้ในคู่มือ UX สำหรับการลงชื่อเข้าใช้

การแชร์โทเค็นชั้นข้อมูล

แอปที่ใช้ร่วมกันในโทรศัพท์สามารถโอนข้อมูลการตรวจสอบสิทธิ์ไปยังแอป Wear OS ได้อย่างปลอดภัยโดยใช้ Wearable Data Layer API โอนข้อมูลเข้าสู่ระบบเป็นข้อความหรือเป็นรายการข้อมูล

โดยปกติแล้ว การตรวจสอบสิทธิ์ประเภทนี้ไม่จำเป็นต้องมีการดำเนินการใดๆ จากผู้ใช้ อย่างไรก็ตาม โปรดหลีกเลี่ยงการตรวจสอบสิทธิ์โดยไม่แจ้งให้ผู้ใช้ทราบว่ากำลังลงชื่อเข้าใช้ คุณสามารถแจ้งให้ผู้ใช้ทราบโดยใช้หน้าจอที่ปิดได้ซึ่งแสดงให้เห็นว่าระบบกำลังโอนบัญชีจากอุปกรณ์เคลื่อนที่

สำคัญ: แอป Wear OS ต้องมีวิธีการตรวจสอบสิทธิ์อื่นๆ อย่างน้อย 1 วิธี เนื่องจากตัวเลือกนี้ใช้ได้เฉพาะกับนาฬิกาที่จับคู่กับ Android เมื่อติดตั้งแอปบนอุปกรณ์เคลื่อนที่ที่เกี่ยวข้องเท่านั้น ระบุวิธีการตรวจสอบสิทธิ์อื่นสำหรับผู้ใช้ที่ไม่มีแอปบนอุปกรณ์เคลื่อนที่ที่เกี่ยวข้องหรือผู้ที่จับคู่อุปกรณ์ Wear OS กับอุปกรณ์ iOS

ส่งโทเค็นโดยใช้ชั้นข้อมูลจากแอปบนอุปกรณ์เคลื่อนที่ ดังที่แสดงในตัวอย่างต่อไปนี้

val token = "..." // Auth token to transmit to the Wear OS device.
val putDataReq: PutDataRequest = PutDataMapRequest.create("/auth").run {
    dataMap.putString("token", token)
    asPutDataRequest()
}
val putDataTask: Task<DataItem> = Wearable.getDataClient(this).putDataItem(putDataReq)

รอรับเหตุการณ์การเปลี่ยนแปลงข้อมูลในแอป Wear OS ดังที่แสดงในตัวอย่างต่อไปนี้

class AuthDataListenerService : WearableListenerService() {
    override fun onDataChanged(dataEvents: DataEventBuffer) {
        dataEvents.forEach { event ->
            if (event.type == DataEvent.TYPE_CHANGED) {
                val dataItemPath = event.dataItem.uri.path ?: ""

                if (dataItemPath.startsWith("/auth")) {
                    val token = DataMapItem.fromDataItem(event.dataItem)
                        .dataMap
                        .getString("token")
                    // Display an interstitial screen to notify the user that they're being signed
                    // in. Then, store the token and use it in network requests.
                    handleSignInSequence(token)
                }
            }
        }
    }

    /** placeholder sign in handler. */
    fun handleSignInSequence(token: String?) {}
}

ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้ Wearable Data Layer ได้ที่ส่งและซิงค์ข้อมูลใน Wear OS

ใช้ OAuth 2.0

Wear OS รองรับขั้นตอนที่อิงตาม OAuth 2.0 จำนวน 2 ขั้นตอน ซึ่งอธิบายไว้ในส่วนต่อไปนี้

  • การให้สิทธิ์รหัสการให้สิทธิ์ที่มี Proof Key for Code Exchange (PKCE) ตามที่ระบุไว้ใน RFC 7636
  • Device Authorization Grant (DAG) ตามที่ระบุไว้ใน RFC 8628
Proof Key for Code Exchange (PKCE)

หากต้องการใช้ PKCE อย่างมีประสิทธิภาพ ให้ใช้ RemoteAuthClient จากนั้นหากต้องการส่งคำขอการตรวจสอบสิทธิ์จากแอป Wear OS ไปยังผู้ให้บริการ OAuth ให้สร้างออบเจ็กต์ OAuthRequest ออบเจ็กต์นี้ประกอบด้วย URL ไปยังปลายทาง OAuth เพื่อรับโทเค็นและออบเจ็กต์ CodeChallenge

โค้ดต่อไปนี้แสดงตัวอย่างการสร้างคำขอตรวจสอบสิทธิ์

val oauthRequest = OAuthRequest.Builder(context)
    .setAuthProviderUrl(uri)
    .setCodeChallenge(codeChallenge)
    .setClientId(CLIENT_ID)
    .build()

หลังจากสร้างคำขอการตรวจสอบสิทธิ์แล้ว ให้ส่งคำขอดังกล่าวไปยังแอปที่ใช้ร่วมกันโดยใช้เมธอด sendAuthorizationRequest() ดังนี้

RemoteAuthClient.create(context).sendAuthorizationRequest(
    request = oauthRequest,
    executor = { command -> command?.run() },
    clientCallback = object : RemoteAuthClient.Callback() {
        override fun onAuthorizationResponse(
            request: OAuthRequest,
            response: OAuthResponse
        ) {
            // Extract the token from the response, store it, and use it in requests.
            continuation.resume(parseCodeFromResponse(response))
        }
        override fun onAuthorizationError(request: OAuthRequest, errorCode: Int) {
            // Handle Errors
            continuation.resume(Result.failure(IOException("Authorization failed")))
        }
    }
)

คำขอนี้จะทริกเกอร์การเรียกไปยังแอปที่ใช้ร่วมกัน ซึ่งจะแสดง UI การให้สิทธิ์ในเว็บเบราว์เซอร์บนโทรศัพท์มือถือของผู้ใช้ ผู้ให้บริการ OAuth 2.0 จะตรวจสอบสิทธิ์ผู้ใช้และขอความยินยอมจากผู้ใช้สำหรับสิทธิ์ที่ขอ ระบบจะส่งการตอบกลับไปยัง URL เปลี่ยนเส้นทางที่สร้างขึ้นโดยอัตโนมัติ

หลังจากให้สิทธิ์สำเร็จหรือล้มเหลว เซิร์ฟเวอร์ OAuth 2.0 จะเปลี่ยนเส้นทางไปยัง URL ที่ระบุไว้ในคำขอ หากผู้ใช้อนุมัติคำขอเข้าถึง การตอบกลับจะมีรหัสการให้สิทธิ์ หากผู้ใช้ไม่อนุมัติคำขอ การตอบกลับจะมีข้อความแสดงข้อผิดพลาด

การตอบกลับจะอยู่ในรูปแบบของสตริงคำค้นหาและมีลักษณะเหมือนกับตัวอย่างต่อไปนี้

  https://wear.googleapis.com/3p_auth/com.your.package.name?code=xyz
  https://wear.googleapis-cn.com/3p_auth/com.your.package.name?code=xyz

ซึ่งจะโหลดหน้าเว็บที่นำผู้ใช้ไปยังแอปที่ใช้ร่วมกัน แอปที่ใช้ร่วมกันจะยืนยัน URL การตอบกลับและส่งต่อการตอบกลับไปยังแอป Wear OS โดยใช้ onAuthorizationResponse API

จากนั้นแอปสมาร์ทวอทช์จะแลกรหัสการให้สิทธิ์เป็นโทเค็นเพื่อการเข้าถึงได้

การให้สิทธิ์อุปกรณ์

เมื่อใช้การให้สิทธิ์การให้สิทธิ์อุปกรณ์ ผู้ใช้จะเปิด URI การยืนยันในอุปกรณ์อื่น จากนั้นเซิร์ฟเวอร์การให้สิทธิ์จะขอให้ผู้ใช้อนุมัติหรือปฏิเสธคำขอ

เพื่อให้กระบวนการนี้ง่ายขึ้น ให้ใช้ RemoteActivityHelper เพื่อเปิดหน้าเว็บบนอุปกรณ์เคลื่อนที่ที่จับคู่ของผู้ใช้ ดังที่แสดงในตัวอย่างต่อไปนี้

// Request access from the authorization server and receive Device Authorization Response.
private fun verifyDeviceAuthGrant(verificationUri: String) {
    RemoteActivityHelper(context).startRemoteActivity(
        Intent(Intent.ACTION_VIEW).apply {
            addCategory(Intent.CATEGORY_BROWSABLE)
            data = Uri.parse(verificationUri)
        },
        null
    )
}

หากคุณมีแอป iOS ให้ใช้ Universal Link เพื่อสกัดกั้น Intent นี้ในแอปแทนการพึ่งพาเบราว์เซอร์เพื่อให้สิทธิ์โทเค็น