node-red API와 Auth설정

✅ Node-red 설정파일(settings.js)

- 나는 도커 위에 node-red 올린 거라서 아래 명령어로 settings.js 파일을 찾을 수 있었다.

> docker exec -it nodered /bin/bash
> vi /data/settings.js

• node-red가 시작될 때 최초로 한 번만 적용되는 설정이다.
• 설정파일을 수정 후 적용하려면 node-red를 껐다 켜야 한다.

 

📌 httpAdminRoot 설정

• httpAdminRoot에 경로를 설정해주면, 해당 경로가 루트 경로가 된다.
• 디폴트 루트 경로는 `/` 이므로 `http://서버아이피:1880` 로 접속하면 된다.

 

📌 adminAuth 설정

• 노드 레드 editor나 admin API를 사용할 때 사용자 인증을 어떻게 할지 설정하는 부분
• 디폴트로는 인증 없이 사용할 수 있도록 되어 있다.
• username와 패스워드(bcrypt로 암호화된 형태)를 적어주고, permissions 에는 * 또는 read를 적어주면 된다.
• 사용자 인증이 필요하도록 설정할 경우, 노드레드 API를 사용하려면
  • username과 password를 이용해 토큰을 발급받아서,
  • 요청을 보낼 때 Authorization 헤더에 발급받은 토큰을 담아주어야 한다.

 

 

✅ Node-red API

📌 GET /flows

• 현재 배포되어있는 flows.json 파일을 응답 body에 담아 보낸다.

📌 POST /flows

• 현재 flows를 요청 body에 담긴 flows.json으로 수정하여 배포한다.

https://nodered.org/docs/api/admin/methods/

 

🐣 flows.json

• json 배열 형태이고 각 json 객체 하나는 탭 또는 노드이다.
• Node-red에서 자주 사용하는 노드들이 클래스 형태로 정의된 라이브러리가 있는지 찾아봤지만,
• Java에도, JavaScript에도 없었음.

→ flows 수정하려면, 우리가 어떻게든 flows.json을 직접 작성해서 POST /flows 요청 보내야함

flows.json 예시

[
    {
        "id": "9b9dc9d130c425ba",
        "type": "mqtt in",
        "z": "f6f2187d.f17ca8",
        "name": "",
        "topic": "#",
        "qos": "2",
        "datatype": "auto-detect",
        "broker": "e4c4de3f1d988aba",
        "nl": false,
        "rap": true,
        "rh": 0,
        "inputs": 0,
        "x": 270,
        "y": 260,
        "wires": [
            [
                "478118ba5279275d"
            ]
        ]
    },
    {
        "id": "7c06fcd191b77fab",
        "type": "mqtt out",
        "z": "f6f2187d.f17ca8",
        "name": "",
        "topic": "",
        "qos": "",
        "retain": "",
        "respTopic": "",
        "contentType": "",
        "userProps": "",
        "correl": "",
        "expiry": "",
        "broker": "e4c4de3f1d988aba",
        "x": 550,
        "y": 260,
        "wires": []
    },
    {
        "id": "478118ba5279275d",
        "type": "function",
        "z": "f6f2187d.f17ca8",
        "name": "function 1",
        "func": "msg.payload.time = Math.floor(Date.now()/1000);\\nreturn msg;",
        "outputs": 1,
        "timeout": 0,
        "noerr": 0,
        "initialize": "",
        "finalize": "",
        "libs": [],
        "x": 420,
        "y": 260,
        "wires": [
            [
                "7c06fcd191b77fab",
                "6c977802da75f838"
            ]
        ]
    },
    {
        "id": "6c977802da75f838",
        "type": "debug",
        "z": "f6f2187d.f17ca8",
        "name": "debug 1",
        "active": false,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "statusVal": "",
        "statusType": "auto",
        "x": 580,
        "y": 180,
        "wires": []
    },
    {
        "id": "e4c4de3f1d988aba",
        "type": "mqtt-broker",
        "name": "맥미니",
        "broker": "192.168.70.203",
        "port": "1883",
        "clientid": "",
        "autoConnect": true,
        "usetls": false,
        "protocolVersion": "4",
        "keepalive": "60",
        "cleansession": true,
        "autoUnsubscribe": true,
        "birthTopic": "",
        "birthQos": "0",
        "birthPayload": "",
        "birthMsg": {},
        "closeTopic": "",
        "closePayload": "",
        "closeMsg": {},
        "willTopic": "",
        "willQos": "0",
        "willPayload": "",
        "willMsg": {},
        "userProps": "",
        "sessionExpiry": ""
    }
]

 

- 첫 번째 예시: flow 추가

POST http://localhost:1880/flows

[
    {
        "id": "edc211502dc456d3",
        "type": "mqtt in",
        "z": "e30ff5fe7777e085",
        "name": "",
        "topic": "#",
        "qos": "2",
        "datatype": "auto-detect",
        "broker": "4f5d917ba7bff899",
        "nl": false,
        "rap": true,
        "rh": 0,
        "inputs": 0,
        "x": 470,
        "y": 380,
        "wires": [
            [
                "f77710ba99621141"
            ]
        ]
    },
    {
        "id": "f77710ba99621141",
        "type": "function",
        "z": "e30ff5fe7777e085",
        "name": "add time",
        "func": "msg.payload.time = Math.floor(Date.now() / 1000);\\nreturn msg;",
        "outputs": 1,
        "timeout": 0,
        "noerr": 0,
        "initialize": "",
        "finalize": "",
        "libs": [],
        "x": 620,
        "y": 380,
        "wires": [
            [
                "0c3c71a50fcaef03"
            ]
        ]
    },
    {
        "id": "0c3c71a50fcaef03",
        "type": "mqtt out",
        "z": "e30ff5fe7777e085",
        "name": "",
        "topic": "",
        "qos": "",
        "retain": "",
        "respTopic": "",
        "contentType": "",
        "userProps": "",
        "correl": "",
        "expiry": "",
        "broker": "4f5d917ba7bff899",
        "x": 770,
        "y": 380,
        "wires": []
    },
    {
        "id": "4f5d917ba7bff899",
        "type": "mqtt-broker",
        "name": "맥미니",
        "broker": "192.168.70.203",
        "port": "1883",
        "clientid": "",
        "autoConnect": true,
        "usetls": false,
        "protocolVersion": "4",
        "keepalive": "60",
        "cleansession": true,
        "autoUnsubscribe": true,
        "birthTopic": "",
        "birthQos": "0",
        "birthRetain": "false",
        "birthPayload": "",
        "birthMsg": {},
        "closeTopic": "",
        "closeQos": "0",
        "closeRetain": "false",
        "closePayload": "",
        "closeMsg": {},
        "willTopic": "",
        "willQos": "0",
        "willRetain": "false",
        "willPayload": "",
        "willMsg": {},
        "userProps": "",
        "sessionExpiry": ""
    }
]

요청 보내면 “플로우가 변경되었습니다” 라고 표시되면서 자동 배포됨

 

- 두 번째 예시: 여러 탭 추가

type: tab

id: 탭 아이디

z : 노드가 속한 탭의 아이디

POST http://localhost:1880/flows

[
    {
        "id": "ababab",
        "type": "tab",
        "label": "Flow ONE",
        "disabled": false,
        "info": ""
    },
    {
        "id": "8968361bdf2072f1",
        "type": "inject",
        "z": "ababab",
        "name": "",
        "props": [
            {
                "p": "payload"
            },
            {
                "p": "topic",
                "vt": "str"
            }
        ],
        "repeat": "",
        "crontab": "",
        "once": false,
        "onceDelay": 0.1,
        "topic": "",
        "payload": "",
        "payloadType": "date",
        "x": 600,
        "y": 440,
        "wires": [
            [
                "c48c9fc37e393400"
            ]
        ]
    },
    {
        "id": "c48c9fc37e393400",
        "type": "debug",
        "z": "ababab",
        "name": "debug 1",
        "active": true,
        "tosidebar": true,
        "console": false,
        "tostatus": false,
        "complete": "false",
        "statusVal": "",
        "statusType": "auto",
        "x": 770,
        "y": 440,
        "wires": []
    },

    {
        "id": "aaabbbb",
        "type": "tab",
        "label": "Flow TWO",
        "disabled": false,
        "info": ""
    },
    {
        "id": "bbbbbddddd",
        "type": "function",
        "z": "aaabbbb",
        "name": "function",
        "func": "msg.payload.time = Math.floor(Date.now()/1000);\\nreturn msg;",
        "outputs": 1,
        "timeout": 0,
        "noerr": 0,
        "initialize": "",
        "finalize": "",
        "libs": [],
        "x": 420,
        "y": 260,
        "wires": [
            [
                "7c06fcd191b77fab"
            ]
        ]
    }
]

 

 

✅ Auth 설정하기

• 공식 문서: https://nodered.org/docs/api/admin/

📌 GET /auth/login (Authentication 정보 확인하기)

• settings.json에 adminAuth 별도로 설정되어 있지 않으면, 응답 바디에 아무 것도 담기지 않고 옴

 

 

• settings.json에 adminAuth 설정되어 있으면, 응답 바디에 Authentication scheme이 담겨서 옴

 

 

 

 

• 위에서 말했지만, settings.js은 node-red가 시작될 때 최초 한 번 적용되는 설정이다.
• 그래서 중간에 계정을 추가하거나 인증 방식을 바꾸고 싶으면 settings.js 파일을 수정한 뒤 노드레드를 재시작 해주어야 한다.
• settings.js을 수정하는 API는 따로 없고, 직접 서버에 들어가서 수정해주어야 한다.
• (Node.js같은 경우 node-red를 imbed하면 자바스크립트 코드에서 바로 settings.js 설정을 할 수 있긴 함)

 

 

📌 settings.js adminAuth설정

• username: 유저이름
• password: bcrypt로 인코딩 된 해시값
• permissions: * 또는 read 중 하나

설정파일 수정 후 노드레드 restart 하면 적용된다.

 

 

📌 POST /auth/token (토큰 발급받기)

body에 필수 정보들을 담아서 POST 요청을 보내면 토큰이 응답으로 온다.

• client_id : node-red-admin 또는 node-red-editor 둘 중 하나 적어주어야 한다.
• grant_type : 무조건 password라고 적어주어야 한다.
• scope: * 또는 read 중 하나 적어주어야 한다.
• username: 인증에 사용할 유저이름
• password: 인증에 필요한 패스워드(암호화되지 않은 plain text)

잘못된 정보로 post 보내면 403 응답과 비밀번호 틀렸다는 메시지가 오고 토큰은 발급되지 않는다.

 

 

📌 발급받은 토큰으로 node-red API 이용하기

• 이제 API를 사용하려면 Authorization 헤더에 “Bearer [위에서 발급받은 토큰]”을 담아주어야 한다.

토큰 없이 GET /flows 요청 보내면, 401 뜬다.

 

 

토큰을 넣어주면 API 사용 가능하다.