Securely pass a Coder session token to the (System) Network Extension

Abierto
  • ¿Algo no está bien?
#33 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
macos, swift
Área
desktop, operating-systems, security

Línea de trabajo

Empieza rastreando la ruta NETunnelProviderProtocol.providerConfiguration y el punto de entrada NEPacketTunnelProvider.startTunnel descritos en el issue. Revisa las alternativas de Keychain y XPC y, a continuación, define la finalización como la entrega segura del token de sesión sin almacenarlo en providerConfiguration.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

The Network Extension requires a session token for a Coder deployment in order to function. This is (and should be) stored in the macOS Keychain.

When registering the network extension as a system VPN, a NETunnelProviderProtocol can be configured and passed to the network extension when it's started (via NEPacketTunnelProvider.startTunnel). NETunnelProviderProtocol.serverAddress allows us to pass the access URL of the deployment.

NETunnelProviderProtocol.passwordReference is described as:

a persistent reference to a keychain item with the kSecClassGenericPassword class.

This field doesn't take into account the fact that the Network Extension might be a System Extension (as opposed to an app extension, used when submitting the application to the macOS/iOS App Store).

For reference, the WireGuard macOS app uses an app extension, running as the user, not root. It's able to pass a keychain reference to that app extension after modifying the item's keychain ACL.

In our case, there's a few problems:

  1. Whilst Keychain Access Groups exist to share keychain items between multiple sandboxed applications, they require all apps use the data protection keychain (as opposed to the file-based keychain).
    Programs that run outside of the user context (such as our NE, running as root), cannot use the data protection keychain. [1] [2]
  2. File-based keychains are accessible from both users and the network-extensions. However, the sandboxed application is only capable of writing to the user keychain, and the network extension is only capable of reading from the system keychain. The application would need elevated permissions to write to the system keychain, and use passwordReference to pass a keychain persistentRef. [3] [4]

The dev forum solution appears to be to send the credentials over some IPC, which would definitely be XPC in our case ([3], [4]). However, sending the session token over XPC in our case might lead to an annoying implementation: when the VPN is started it first must wait for yet another message containing the session token.

Instead, the current (hacked) solution involves just storing the session token within the NETunnelProviderProtocol.providerConfiguration dictionary. I believe the only difference between this and XPC is that this configuration is written to disk. We currently store Coder CLI tokens on disk too right now, though it'd be good to improve both situations in the future.

More:
https://developer.apple.com/forums/thread/694431

Lenguaje dominante
Swift
Estrellas
29
Forks
9
Merge medio
1 d 17 h
PR fusionados (30 d)
5

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de coder/coder-desktop-macos

Todos los issues de coder/coder-desktop-macos

Issues similares

Más issues de Swift

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.