Adding auth in socket request

[nandarosyadi]

Server need to receive auth token from client, so it needs to send the auth. Is there any ways to add auth in socket request? Thank you

[ajinumoto]

Have you try sending auth token data right after your socket connection was open?

[nandarosyadi]

Thank you for the quick response. Server request to send the auth when starting connection, so it need to send when the connect() method called. Is there any way to do that in current version?

[ajinumoto]

If your token on header and sent during handshake you can try add your token in options during initialization
NWWebSocket(url: socketURL, options: options)
where
options.setAdditionalHeaders([("header_key","your_token")])

[ajinumoto]

let options = NWWebSocket.defaultOptions
options.setAdditionalHeaders([("header_key","your_token")])
NWWebSocket(url: socketURL, options: options)

[nandarosyadi]

Hey @ajinumoto, thanks for the help. Now, I can send my auth but the socket is not connected yet. It's not called the delegate method, so what's wrong here?

Here is my code

    func connectSocket() {
        guard let accessJWT: String = UserDefaultManager.getUserDefault(key: .userData_AccessJWT) else {
            self.delegate.socketDidError(message: "Token socket not found")
            return
        }
        
        self.socketManager?.delegate = self
        
        let socketOption = NWProtocolWebSocket.Options()
        socketOption.setAdditionalHeaders([("token", accessJWT)])
        
        self.socketManager = NWWebSocket(url: self.socketURL, 
                                         connectAutomatically: true,
                                         options: socketOption,
                                         connectionQueue: .main)
                                         
        self.socketManager?.ping(interval: 15)
        
        func webSocketDidConnect(connection: WebSocketConnection) {
        print("Socket: Connected")

        self.socketManager?.ping(interval: 15)
    }

    func webSocketDidDisconnect(connection: WebSocketConnection,
                                closeCode: NWProtocolWebSocket.CloseCode, reason: Data?) {
        print("Socket: Disconnected")

        self.connectSocket()
    }
    
    func webSocketDidConnect(connection: WebSocketConnection) {
        print("Socket: Connected")

        self.socketManager?.ping(interval: 15)
    }

[ajinumoto]

Probably because you set
self.socketManager?.delegate = self
before
self.socketManager = NWWebSocket(url: self.socketURL, connectAutomatically: true, options: socketOption, connectionQueue: .main)
so your delegate is still on old self.socketManager value (or nil)

[nandarosyadi]

I've move the delegate after the NWWebSocket initialization, but the delegate method is not called either

        self.socketManager = NWWebSocket(url: self.socketURL, 
                                         connectAutomatically: true,
                                         options: socketOption,
                                         connectionQueue: .main)
        self.socketManager?.delegate = self
        self.socketManager?.ping(interval: 15)

[ajinumoto]

but the delegate method is not called

All delegate not working really, even the connect and disconnect delegate? If all of delegate are not working, there is something wrong with your code. If you didn't receive message from socket try listen using self.socketManager?.listen()?

Btw, i highly recommend you to see NWWebSocket class for deeper understanding about this library

[brightfuture]

I have encountered the same problem, and using suggested method worked, thanks!
Plus I don't know why there isn't an option to use init(request: URLRequest,
connectAutomatically: Bool = false,
options: NWProtocolWebSocket.Options = NWWebSocket.defaultOptions,
connectionQueue: DispatchQueue = .main)
initializer, as it seems like you can add auth information to a URLRequest as well

[Keith-wright]

Thanks everyone for the discussion here — looks like both the original auth header question and the delegate issue were resolved in the thread.

To clarify the URLRequest initializer point from @brightfuture: init(request:) does exist in the library, but it only uses the URL from the request — there's no mechanism in Apple's Network framework to forward URLRequest headers to an NWProtocolWebSocket connection. For auth headers, the approach @ajinumoto shared above using NWProtocolWebSocket.Options.setAdditionalHeaders is the suggested one.

Closing this out — please open a new issue if you hit something not covered above.