[JS] Homebridge Smartthings 연동 플러그인 제작, OAuth 인증 - 1

[IoT 🏠/Homebridge] - [JS] Homebridge Smartthings 연동 플러그인 제작, OAuth 인증 - 1

[IoT 🏠/Homebridge] - [JS] Homebridge Smartthings 연동 플러그인 제작, 악세서리 매핑 - 2

 

저번에 Homebridge로 Smartthings 연동하는 플러그인을 사용해,

Smartthings 기기들을 Home 앱에 추가하는 작업을 했었다.

 

하지만, Smartthings 정책이 바뀌면서

기존 PAT(개인 액세스 토큰)의 유효기간이 24시간으로 바뀌어버렸다.

 

매번 토큰을 재발급 받고, 서버에서 수정하면서 쓰는건 비효율적이고

어떤 방법으로 구현 해볼지, 정보를 찾아보다가

한 해외 유저가, OAuth 방식을 사용하여 연동하는 것을 보았다.

https://github.com/aziz66/homebridge-smartthings

GitHub - aziz66/homebridge-smartthings: homebridge smartthings plugin

 

테스트 겸 사용해본 결과, 오류도 아직 많고

내가 원하는 기기를 입맛대로 매핑하기가 어려워서

직접 내가 플러그인을 제작하여 연동해 보려고 한다.

 

 

OAuth 프록시 서버 구축

 

먼저, Smartthings의 새 정책에 대응하기 위해, 위의 방식을 벤치마킹 해보자

 

ngrok를 이용하여 https 프록시 서버를 두어 적법한 인증 서버를 두는 것인데,

필자의 iptime 서버는 https를 지원하지 않으므로 이 방식을 적용해 보려 한다.

 

일단 ngrok 공식 홈페이지에 나와있는 설명대로

ubuntu 환경에 ngrok 설치와 토큰 발급을 해야한다.

https://dashboard.ngrok.com/get-started/setup/linux

ngrok — Log in

 

문서에 기재된 내용과 같이,

homebridge 서버가 구축된 ubuntu 환경에 ngrok를 설치해준다.

curl -sSL https://ngrok-agent.s3.amazonaws.com/ngrok.asc \
  | sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null \
  && echo "deb https://ngrok-agent.s3.amazonaws.com bookworm main" \
  | sudo tee /etc/apt/sources.list.d/ngrok.list \
  && sudo apt update \
  && sudo apt install ngrok

 

 

다음으로 ngrok 사이트에서 발급한 토큰도 적용

그 후, 8000번 포트로 실행했다. (유저재량)

ngrok config add-authtoken "token"
ngrok http 8000

 

 

간단한 프록시 서버는 구축 끝.

굳이 ngrok이 아니더라도, CloudFlare나 Nginx + 포트포워딩 방법 등 입맛에 맞게 하면 될 것 같다.

 

 

Smartthing CLI 생성

 

서버가 구축됐으면, 이제 가상 앱이 필요하다.

Smartthings가 제공하는, 명령줄에서 관리가 가능한 CLI 앱을 생성해보도록 하자.

https://developer.smartthings.com/docs/sdks/cli

Get Started With the SmartThings CLI | Developer Documentation | SmartThings

 

이곳에서 기본적으로 CLI를 생성할 토큰을 발급 받고

이전에 PAT 토큰을 발급받는 방법과 같다.

https://account.smartthings.com/tokens

SmartThings. Add a little smartness to your things.

 

Smartthings CLI를 설치 후, 앱 생성을 진행

smartthings apps:create --token "token"

 

 

앱 이름과, 설명을 넣고

Target URL에는 ngrok에서 발급받은 내 프록시 서버 주소를 넣고,

권한은 기본적인 읽기,수정,실행(r/w/x:device:*)

마지막으로 Redirect URL에는 프록시서버 주소에 /oauth/callback을 꼭 붙여서 넣어줘야한다.

 

그럼 정상적으로, Client ID/Secret이 생성된다.

 

 

플러그인 제작

 

먼저 플러그인에서 OAuth 인증 처리를 할 코드부터 구현해보자

 

OAuthServer 클래스를 생성 후, 인증 URL을 생성하는 메서드 부분을 만들어주었다.

권한은 기기 읽기, 실행 등을 넣어주고 (API 문서를 확인해서 더 많은 권한을 넣을 수 있다.)

state로 CSRF 공격 방지 기능도 추가 해 주었다.

getAuthUrl() {
    const scope = 'r:devices:* x:devices:*';
    const state = 'st_state_' + Date.now();

    const authUrl = new URL('https://api.smartthings.com/oauth/authorize');
    authUrl.searchParams.append('response_type', 'code');
    authUrl.searchParams.append('client_id', this.config.clientId);
    authUrl.searchParams.append('scope', scope);
    authUrl.searchParams.append('state', state);
    authUrl.searchParams.append('redirect_uri', this.redirectUri);

    return authUrl.toString();
}

 

 

이제 권한 링크에서 로그인을 마치면,

스마트싱스 서버가 원하는 주소로 리다이렉트 해줄 수 있게 콜백처리를 해주고

async handleOAuthCallback(req, res) {
    const parsedUrl = url.parse(req.url, true);
    const code = parsedUrl.query.code;

    if (!code) {
        res.writeHead(400);
        return res.end('OAuth Error: No code received.');
    }

    try {
        const tokenData = await this.exchangeCodeForToken(code);

        this.platform.accessToken = tokenData.access_token;
        this.platform.refreshToken = tokenData.refresh_token;
        this.platform.persistTokens();

        res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
        res.end('<h1>인증 완료!</h1><p>Homebridge 로그를 확인하고 플러그인을 재시작하세요.</p>');

        this.platform.discoverDevices();
    } catch (error) {
        res.writeHead(500);
        res.end('<h1>Token Exchange Failed.</h1>');
    }
}

 

 

다음으로는 핵심 단계로,

추출한 일회용 코드를 실제 사용될 accessToken으로 바꾸는 메서드이다.

 

아까 CLI로 발급받은 clientId, clientSecret을 결합해 base64로 인코딩을 하고

헤더에 담아 POST 요청을 보내면, accessToken과 refreshToken이 리턴된다.

async exchangeCodeForToken(code) {
    const tokenUrl = 'https://api.smartthings.com/oauth/token';
    const authHeader = Buffer.from(`${this.config.clientId}:${this.config.clientSecret}`).toString('base64');

    const params = new URLSearchParams();
    params.append('grant_type', 'authorization_code');
    params.append('code', code);
    params.append('redirect_uri', this.redirectUri);

    try {
        const response = await axios.post(tokenUrl, params.toString(), {
            headers: {
                'Content-Type': 'application/x-www-form-urlencoded',
                'Authorization': `Basic ${authHeader}`,
                'Accept': 'application/json'
            }
        });
        return response.data;
    } catch (error) {
        const status = error.response ? error.response.status : 'N/A';
        const errorData = error.response ? JSON.stringify(error.response.data) : 'No response data';
        throw new Error(`SmartThings API Error: ${status}`);
    }
}

 

 

마지막으로, 토큰이 없다면 OAuth 서버를 실행시켜,

인증 페이지 주소를 로그에 남겨서 권한 설정을 유도하게 만들어두었다.

start() {
    if (this.platform.accessToken) return;

    const callbackPort = this.config.callbackPort || 8000;
    this.httpServer = http.createServer(this.handleRequest.bind(this));

    this.httpServer.listen(callbackPort, () => {
        const authUrl = this.getAuthUrl();
        this.log.warn('SmartThings OAuth 인증이 필요합니다. 아래 주소를 브라우저에 입력하세요:');
        this.log.warn(`${authUrl}`);
    });
}

 

 

이제, 메인인 index.js에 인증 상태에 따라 분기처리를 구현해주고

(token이 있을때만, OAuth 인증서버 실행)

initAuthentication() {
    if (this.accessToken) {
        this.discoverDevices();
    } else {
        const server = new OAuthServer(this);
        server.start();
    }
}

 

 

OAuthServer 클래스에서 성공적으로 토큰을 받아오면,

fs 모듈을 이용해 새 토큰을 config.json에 자동으로 추가하게 만들었다.

persistTokens() {
    const configPath = this.api.user.configPath();
    try {
        if (!fs.existsSync(configPath)) throw new Error(`설정 파일을 찾을 수 없습니다: ${configPath}`);
    
        const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
        const platformConfig = config.platforms.find(p => p.platform === PLATFORM_NAME);

        if (platformConfig) {
            platformConfig.accessToken = this.accessToken;
            platformConfig.refreshToken = this.refreshToken;
            fs.writeFileSync(configPath, JSON.stringify(config, null, 4), 'utf8');
        }
    } catch (err) {
        this.log.error('자동 저장 실패:', err.message);
    }

    this.discoverDevices();
}

 

 

이 때, 플러그인이 homebridge 서버의 config.json 파일에 접근 해야하므로

ubuntu 에서 권한 부여 명령어를 입력해 주어야 한다.

sudo chmod 664 /var/lib/homebridge/config.json

 

 

그리고 마지막으로 토큰이 만료 됐을시, (24시간)

저장된 refreshToken으로 유효기간이 끝난 accessToken을 갱신하는 함수도 구현했다.

async refreshAccessToken() {
    const tokenUrl = 'https://api.smartthings.com/oauth/token';
    const authHeader = Buffer.from(`${this.config.clientId}:${this.config.clientSecret}`).toString('base64');
    
    const params = new URLSearchParams();
    params.append('grant_type', 'refresh_token');
    params.append('refresh_token', this.refreshToken);

    try {
        const response = await axios.post(tokenUrl, params.toString(), {
            headers: {
                'Content-Type': 'application/x-www-form-urlencoded',
                'Authorization': `Basic ${authHeader}`
            }
        });
        this.accessToken = response.data.access_token;
        this.refreshToken = response.data.refresh_token;
        this.persistTokens();

        return this.accessToken;
    } catch (error) {
        throw error;
    }
}

 

 

코드 작업 완료. 이제 플러그인 설치 후 테스트 해보자

 

 

테스트

 

저번 게시글에서 설명했던 것 처럼 직접 플러그인을 설치 후

플러그인 설정에서, config 파일에 필요한 값들을 넣어주었다.

아까 발급한, CLI ID와 Secret, ngrok으로 만든 프록시 서버 주소(callbackIp)

 

그러면 아까 OAuthServer 클래스에서 구현한대로,

로그에 권한 설정 주소가 나오게 된다.

 

해당 주소로 접속 해서, 권한 설정을 마치면

아까 handleOAuthCallback 메소드에서 구현한 화면이 정상적으로 출력된다.

 

이제 플러그인을 재시작 하면 config파일에

accessToken과 refreshToken이 정상적으로 추가된 것을 볼 수 있다.

 

 

이렇게 https 프록시 서버를 이용해, OAuth 방식으로 토큰을 발급 받고,

24시간 마다 자동으로 만료된 토큰을 갱신하게 하여,

예전의 영구적으로 사용가능한 PAT 방식처럼 얼추 구현해보았다.

 

이제 정상적으로 Smartthings 디바이스들을 불러올 수 있게 됐으니

다음 게시글에서는 실제 사용중인 기기들을 홈브릿지 악세서리에 매핑해보도록 하겠다.

 

 

원본 게시글

https://blog.naver.com/101artspace/224122443835

Homebridge Smartthings 연동 플러그인 제작, OAuth 인증 - 1