기본 콘텐츠로 건너뛰기

socketcluster tutorial - 6. 미들웨어 및 인증 (Middleware and authorization)

미들웨어 및 인증


SocketCluster를 사용하면 클라이언트는 JavaScript를 사용하여 특정 채널로 데이터를 청취하고 발행하여 메시지를 서로 공유할 수 있습니다. 기본적으로 누구나 자신이 좋아하는 채널에 데이터에 수신하고 게시할 수 있습니다. 일부 시스템에서는 이것이 문제가 되지 않지만 대부분의 시스템은 사용자가 서로 상호 작용할 수 있는 방법을 규제하기 위해 어느 정도의 접근 제어가 필요합니다. 대부분의 시스템은 적절한 접근 권한을 시행하기 위해 연결을 인증하고 권한을 부여하는 방법이 필요합니다. 미들웨어 기능은 이러한 모든 작업을 수행할 수 있는 깔끔한 중앙 집중식 방식을 제공합니다.

SocketCluster에서 모든 실시간 이벤트는 서버에서 처리하기 전에 미들웨어 기능을 통과해야 합니다. SocketCluster는 다양한 종류의 상호 작용을 처리할 수 있는 다양한 종류의 미들웨어 라인을 제공합니다. 가장 유용한 미들웨어 라인은 워커 프로세스에 있지만 로드 밸런서(HTTP 용)에 의해 노출되는 미들웨어 라인이 있습니다. 이 튜토리얼에선 워커(실시간) 미들웨어에만 초점을 맞춥니다.

워커는 실시간 scServer 객체를 통해 미들웨어를 노출합니다. 이 객체는 worker.getSCServer()를 사용하여 액세스 할 수 있습니다.

미들웨어 기능을 서버에 추가하려면 다음을 사용해야 합니다.
scServer.addMiddleware (middlewareType, middlewareFunction);
scServer에서 사용할 수있는 미들웨어 유형은 다음과 같습니다.
scServer.MIDDLEWARE_HANDSHAKE
scServer.MIDDLEWARE_SUBSCRIBE
scServer.MIDDLEWARE_PUBLISH_IN
scServer.MIDDLEWARE_PUBLISH_OUT
scServer.MIDDLEWARE_EMIT
middlewareFunction에 전달한 req인자는 사용한 미들웨어의 종류에 따라 다릅니다. 다음 예제의 err객체는 JavaScript의 Error객체를 상속한 사용자 정의 클래스를 기반으로 합니다. 서버에서 스택 트레이스를 사용하지 않는 경우 폼에서 {name: 'MyCustomError', message: 'This is a custom error'} (또는 추가 사용자 정의 속성을 사용하여)와 같은 일반 객체를 next(err)에게 전달할 수 있습니다. 다음은 각 종류의 미들웨어를 사용하는 방법을 보여주는 몇 가지 샘플 코드 스니펫입니다.

핸드쉐이크

// WebSocket 핸드쉐이크용
wsServer.addMiddleware(wsServer.MIDDLEWARE_HANDSHAKE,
  function (req, next) {
    // ...
    if (...) {
      next() // Allow
    } else {
      var err = new MyCustomHandshakeFailedError('Handshake failed');
      next(err); // Block
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);

구독하기

기본 인증 토큰 만료 오류로 실패합니다.
// Error 객체에 사용자 정의 속성을 가질 수 있습니다.
// 서버 측에서 경고를하지 않고 조용히 next () 블록에 true를 전달합니다.
wsServer.addMiddleware(wsServer.MIDDLEWARE_SUBSCRIBE,
  function (req, next) {
    // ...
    if (req.authTokenExpiredError) {
      next(req.authTokenExpiredError); // 기본 인증 토큰 기간 만료 오류로 실패
    } else if (...) {
      next() // Allow
    } else {
      var socketId = req.socket.id;
      var err = new MyCustomSubscribeFailedError(socketId + ' cannot subscribe to channel ' + req.channel);
      // You can have custom properties on your Error object.
      err.code = 1234;
      next(err); // Block
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);

발행

SC는 게시를 위해 두 가지 미들웨어 라인을 지원합니다. MIDDLEWARE_PUBLISH_IN은 게시한 메시지를 처리한 후 (개별 소켓으로 보내기 직전) MIDDLEWARE_PUBLISH_OUT가 캡처한 메시지를 처리하는 동안 브로커에 도달하기 전에 서버에 도달할 때 인바운드 메시지를 캡처합니다. MIDDLEWARE_PUBLISH_OUT을 사용하면 메시지가 특정 소켓에 도달하는 것을 차단할 수 있습니다. 이 경우에는 메시지를 게시한 소켓이 자신의 메시지를 받지 않도록 메시지와 미들웨어를 설계할 수 있습니다.

Publish In

wsServer.addMiddleware(wsServer.MIDDLEWARE_PUBLISH_IN,
  function (req, next) {
    // ...
    if (...) {
      next() // Allow
    } else {
      var err = MyCustomPublishInFailedError(req.socket.id + ' cannot publish channel ' + req.channel);
      next(err); // Block
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);

Publish out

wsServer.addMiddleware(wsServer.MIDDLEWARE_PUBLISH_OUT,
  function (req, next) {
    // ...
    if (...) {
      next() // Allow
    } else {
      var err = MyCustomPublishOutFailedError('Blocked publishing message out to ' + req.socket.id);
      next(err); // Block with notice
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);

전송하기

wsServer.addMiddleware(wsServer.MIDDLEWARE_EMIT,
  function (req, next) {
    // ...
    if (...) {
      next() // Allow
    } else {
      var err = MyCustomEmitFailedError(req.socket.id + ' is not allowed to emit event ' + req.event);
      next(err); // Block
      // next(true); // 서버 측에서 경고하지 않고 조용히 next() 블록에 true를 전달합니다.
    }
  }
);
next() 함수는 언제든지 (비동기가 좋습니다) 호출할 수 있지만, 결과적으로 호출하는 것을 확인해야 합니다. 그렇지 않으면 클라이언트의 subscribe/ publish/emit 액션이 단순 타임아웃이나 클라이언트 쪽에서 원인을 알 수 없는 타임아웃 오류를 발생할 것입니다. 클라이언트가 뭔가를 하지 못하도록 차단하려면 명시적 오류를 주는 것이 더욱 다루기 쉽습니다.

댓글

이 블로그의 인기 게시물

Renoise로 바닥부터 Sound Design (No Sample/No VST)

Renoise는 Ableton Live Standard 버전처럼 기본적으로 아무 악기가 없고 달랑 샘플러 하나가 전부인데 그마나 다행인건 멀티레이어라고나 할까. 샘플러만 있으면 사실 다 되지. 아날로그 웨이브 테이블을 최소단위로 넣어서 루프를 돌리면  되니까. 근데 그러면 무조건 폴리포니가 되어서 구조적으로 모노 신스는 구현이 불가능하다. 그것도 방법이 없는 건 아닌데 Bend 라든가 Glide 등등으로 하면 되니까. 그래도 모노 신스가 있었으면 좋겠는데 방법이 있더라. http://forum.renoise.com/index.php?/topic/27225-renoise-native-monophonic-synthesiser/  이 글을 보고 약간 충격을 받음. 이펙터만 있으면 역시 소리를 만들 수 있구나! 바로 시도에 들어감. 처음은 이런 상태. 나는 누군가. 여긴 어딘가. 키보드를 눌러도 아무 소리가 안난다. ESC 눌러서 첫번째 트랙 맨위에 Z(C-4 00) 하나 눌러 놓고 일단 플레이. 일단 이렇게 해놓고 소리가 날 수 있게 한단 말이지. 그럼 먼저 제네레이터. 일단 1byte짜리라도 뭐가 있어야 시작을 할 수 있으니 빈 샘플을 만들자. 1byte 짜리 빈 샘플을 만든다. 당연히 소리가 안난다. DC Offset을 만들어 00 인 상태를 바꿔보자. 퍽하고 클릭음이 생기면서 Master Scope 에 변화가 생겼다. Meter도 생겼다. 그런데 이건 소리라고 할 수 없다. RingMod(Ring Modulator)를 추가해보자. 오오 소리가 난다. 0인 경우엔 Ring Modulator를 적용해도 0으로 소용이 없지만 DC Offset으로 값을 변경한 후부터 Oscillator에 따라 파형이 생긴다. 기본적으로 440Hz의 음을 들을 수 있다. 무에서 유를 만들기는 했는데 Pitch도 Volume도 없다. 일단 Pitch부터 해보자. Key Tracker로 Dest...

MQTT 접속해제 - LWT(Last will and testament)

통신에서 중요하지만 구현이 까다로운 문제로 "상대방이 예상치 못한 상황으로 인하여 접속이 끊어졌을때"의 처리가 있다. 이것이 까다로운 이유는 상대방이 의도적으로 접속을 종료한 경우는 접속 종료 직전에 자신의 종료 여부를 알리고 나갈 수 있지만 프로그램 오류/네트웍 연결 강제 종료와 같은 의도치 않은 상황에선 자신의 종료를 알릴 수 있는 방법 자체가 없기 때문이다. 그래서 전통적 방식으로는 자신의 생존 여부를 계속 ping을 통해 서버가 물어보고 timeout 시간안에 pong이 안올 경우 서버에서 접속 종료를 인식하는 번거로운 방식을 취하는데 MQTT의 경우 subscribe 시점에서 자신이 접속 종료가 되었을 때 특정 topic으로 지정한 메시지를 보내도록 미리 설정할 수 있다. 이를 LWT(Last will and testament) 라고 한다. 선언을 먼저하고 브로커가 처리하게 하는 방식인 것이다. Last Will And Testament 라는 말 자체도 흥미롭다. 법률용어인데  http://www.investopedia.com/terms/l/last-will-and-testament.asp 대략 내가 죽으면 뒷산 xx평은 작은 아들에게 물려주고 어쩌고 하는 상속 문서 같은 내용이다. 즉, 내가 죽었을(연결이 끊어졌을) 때에 변호사(MQTT Broker - ex. mosquitto/mosca/rabbitMQ등)로 하여금 나의 유언(메시지)를 상속자(해당 토픽에 가입한 subscriber)에게 전달한다라는 의미가 된다. MQTT Client 가 있다면 한번 실습해보자. 여러가지가 있겠지만 다른 글에서처럼  https://www.npmjs.com/package/mqtt  을 사용하도록 한다. npm install mqtt --save 로 설치해도 되고 내 경우는 자주 사용하는 편이어서 npm install -g mqtt 로 전역설치를 했다. 호스트는 무료 제공하고 있는 test.mosquitto.o...

cURL로 cookie를 다루는 법

http://stackoverflow.com/questions/22252226/passport-local-strategy-and-curl 레거시 소스를 보다보면 인증 관련해서 cookie를 사용하는 경우가 있는데 가령 REST 서버인 경우 curl -H "Content-Type: application/json" -X POST -d '{"email": "aaa@bbb.com", "pw": "cccc"}' "http://localhost/login" 이렇게 로그인이 성공이 했더라도 curl -H "Content-Type: application/json" -X GET -d '' "http://localhost/accounts/" 이런 식으로 했을 때 쿠키를 사용한다면 당연히 인증 오류가 날 것이다. curl의 --cookie-jar 와 --cookie 옵션을 사용해서 cookie를 저장하고 꺼내쓰자. 각각 옵션 뒤엔 저장하고 꺼내쓸 파일이름을 임의로 지정하면 된다. 위의 과정을 다시 수정해서 적용하면 curl -H --cookie-jar jarfile "Content-Type: application/json" -X POST -d '{"email": "aaa@bbb.com", "pw": "cccc"}' "http://localhost/login" curl -H --cookie jarfile "Content-Type: application/json" -X GET -d '' "http://localhost/accounts/" 이렇게 사용하면 ...