- cors
- node.js로 서버 구축, express로 리팩토링, API Server직접 구현하며 라우팅
- API 서버 구현을 할 수 없다면 동적 활동을 할 수 없는 클라이언트만 구현하게 될 것임.
Chapter1. CORS
1-1 CORS, SOP
1-2 CORS 동작 방식
1-3. CORS 설정 방법Chapter2. Refactor Express
2-1. Express 시작하기
2-2. Middleware
Chapter1. CORS
CORS가 필요하게 된 배경 "SOP"
📌 SOP(Same-Origin Policy)
동일 출처 정책. 같은 출처(Origin)의 리소스만 공유가 가능하다
출처 : 프로토콜(https://) 호스트(www.naver.com:443) 포트(:443)의 조합. 이 중 하나라도 다르다면 동일한 출처로 보지 않는다.
SOP 탄생 원인
- 동일 출처 정책은 잠재적으로 해로울 수 있는 문서를 분리함으로써 공격받을 수 있는 경로를 줄여준다.
- SOP은 애초에 다른 사이트와의 리소스 공유를 제한하기 때문에 로그인 정보가 타 사이트의 코드에 의해 새어나가는 걸 방지한다. 그래서 모든 브라우저에서 기본적으로 사용하고 있는 정책.
- 하지만, 다른 출처의 리소스를 사용하게 될 일은 많다. 어떻게 해야 SOP정책을 사용하면서도 다른 출처의 리소스를 받아올 수 있을까 = CORS
📌 CORS(Cross-Origin Resource Sharing)
교차 출처 리소스 공유.
추가 HTTP 헤더를 사용하여, 한 출처에서 실행 중인 웹 애플리케이션이 다른 출처의 선택한 자원에 접근할 수 있는 권한을 부여하도록 브라우저에 알려주는 체제
즉, 브라우저는 SOP에 의해 기본적으로 다른 출처의 리소스 공유를 막지만, CORS를 사용하면 접근 권한을 얻을 수 있게 된다.
📌 CORS 동작 방식
- 프리플라이트 요청 (Preflight Request)
- 단순 요청 (Simple Request)
- 인증정보를 포함한 요청 (Credentialed Request)
1. 프리플라이트 요청
실제 요청을 보내기 전, OPTIONS 메서드로 사전 요청을 보내 해당 출처 리소스에 접근 권한이 있는지부터 확인하는 것
1. 브라우저는 서버에 실제 요청을 보내기 전에 프리플라이트 요청을 보냄
2. 응답 헤더의 Access-Control-Allow-Origin으로 요청을 보낸 출처가 돌아오면
3. 실제 요청을 보냄
// 만약 요청을 보낸 출처가 접근 권한이 없다면,
브라우저에서 CORS 에러를 띄우고, 실제 요청은 전달되지 않음
프리플라이트 요청이 필요한 이유
- 실제 요청을 보내기 전에 미리 권한을 확인할 수 있어서 리소스 측면에서 효율적임
- CORS에 대비가 되어있지 않은 서버를 보호할 수 있음. CORS 이전에 만들어진 서버들은 SOP요청만 들어오는 상황을 고려하고 만들어졌으므로 다른 출처에서 들어오는 요청에 대한 대비가 되어있지 않음.
- 이런 서버라도 프리플라이트 요청을 먼저 보내게 되면, 프리플라이트 요청에서 CORS 에러를 띄우게 된다.
같이 실행되면 안 되는 Cross-Origin 요청이 실행되는 걸 방지하므로 프리플라이트 요청이 CORS의 기본 사양으로 들어가게 되었다.
- 이런 서버라도 프리플라이트 요청을 먼저 보내게 되면, 프리플라이트 요청에서 CORS 에러를 띄우게 된다.
2. 단순 요청
특정 조건이 만족되면 프리플라이트 요청을 생략하고 요청을 보내는 것
특정 조건
GET,HEAD,POST요청 중 하나일 것- 자동으로 설정되는 헤더 외에,
Accept,Accept-Language,Content-Language,Content-Type헤더의 값만 수동으로 설정할 수 있다.Content-Type헤더에는application/x-www-form-urlencoded,multipart/form-data,text/plain값만 허용된다.
3. 인증정보를 포함한 요청
요청 헤더에 인증 정보를 담아 보내는 요청.
출처가 다를 경우엔 별도의 설정을 하지 않으면 쿠키🍪를 보낼 수 없다. (민감한 정보이기 때문).
이러한 경우엔 프론트, 서버 모두 CORS 설정이 필요하다.
- 프론트 측 : 요청 헤더에
withCredentials : true넣어줄 것. - 서버 측 : 응답 헤더에
Access-Control-Allow-Credentials : true를 넣어줄 것.- 서버 측에서
Access-Control-Allow-Origin을 설정할 때, 모든 출처를 허용한다는 뜻의 와일드카드(*)로 설정하면 에러가 발생한다. 인증 정보를 다루는 만큼 출처를 정확하게 설정할 것.
- 서버 측에서
📌 CORS 설정 방법
1. Node.js 서버
Node.js로 간단한 HTTP 서버를 만들 경우, 다음과 같이 응답 헤더를 설정
const http = require('http');
const server = http.createServer((request, response) => {
// 모든 도메인
response.setHeader("Access-Control-Allow-Origin", "*");
// 특정 도메인
response.setHeader("Access-Control-Allow-Origin", "https://codestates.com");
// 인증 정보를 포함한 요청을 받을 경우
response.setHeader("Access-Control-Allow-Credentials", "true");
})2. Express 서버
Express 프레임워크를 사용해서 서버를 만들 경우, cors 미들웨어를 사용해서 보다 더 간단하게 CORS 설정
const cors = require("cors");
const app = express();
//모든 도메인
app.use(cors());
//특정 도메인
const options = {
origin: "https://codestates.com", // 접근 권한을 부여하는 도메인
credentials: true, // 응답 헤더에 Access-Control-Allow-Credentials 추가
optionsSuccessStatus: 200, // 응답 상태 200으로 설정
};
app.use(cors(options));
//특정 요청
app.get("/example/:id", cors(), function (req, res, next) {
res.json({ msg: "example" });
});ㅎㅎ
브라우저에는 서버에 요청을 보내기 위해 fetch같은 HTTP 요청을 보내는 도구가 기본적으로 내장되어 있음. 서버는 클라이언트(브라우저)의 HTTP 요청에 맞게 응답을 보낼 수 있도록 코드를 작성해야 함.
Node.js는 HTTP 요청을 보내거나 응답을 받을 수 있는 도구를 제공하는 프로그램인 웹 서버를 제공함.
HTTP 트랜잭션 해부(Anatomy of an HTTP Transaction)
Chapter2. Refactor Express
-
Express 설치
npm install express
const express = require('express')
const app = express()
const port = 3000
app.get('/', (req, res) => {
res.send('Hello World!')
})
app.listen(port, () => {
console.log(`Example app listening on port ${port}`)
// [코드] 응답으로 'Hello World!' 를 보내는 Express 서버 코드- 라우팅: 메서드와 url에 따라 분기(Routing)하기
라우팅 : 메서드와 url(/lower,/upper등)로 분기점을 만드는 것
클라이언트는 특정한 HTTP 요청 메서드(GET, POST 등)와 함께 서버의 특정 URI(또는 경로)로 HTTP 요청을 보냄, 라우팅은 클라이언트의 요청에 해당하는 Endpoint에 따라 서버가 응답하는 방법을 결정
const requestHandler = (req, res) => {
if(req.url === '/lower') {
if (req.method === 'GET') {
res.end(data)
} else if (req.method === 'POST') {
req.on('data', (req, res) => {
// do something ...
})
}
}
}
/// [코드] Node.js로 라우팅을 구현한 코드반면에 Express는 프레임워크 자체에서 라우터 기능을 제공
Express의 라우터를 활용한 코드
const router = express.Router()
router.get('/lower', (req, res) => {
res.send(data);
})
router.post('/lower', (req, res) => {
// do something
})📌 Middleware
프로세스 중간에 관여하여 특정 역할을 수행 자동차 공장의 공정과 비슷.
컨베이어 벨트 위에 올라가 있는 요청(Request)에 필요한 기능을 더하거나, 문제가 발견된 불량품을 밖으로 걷어내는 역할.
미들웨어를 이용하면 Node.js 만으로 구현한 서버에서는 번거로울 수 있는 작업을 쉽게 적용할 수 있다.
미들웨어 사용
- POST 요청 등에 포함된 body(payload)를 구조화할 때(쉽게 얻어내고자 할 때)
- 모든 요청/응답에 CORS 헤더를 붙여야 할 때
- 모든 요청에 대해 url이나 메서드를 확인할 때
- 요청 헤더에 사용자 인증 정보가 담겨있는지 확인할 때
1: POST 요청 등에 포함된 body(payload)를 구조화할 때
Node.js로 HTTP body(payload)를 받을 때 : Buffer를 조합해서 다소 복잡한 방식으로 body를 얻어냄. 네트워크 상의 chunk를 합치고, buffer를 문자열로 변환하는 작업이 필요
let body = [];
request.on('data', (chunk) => {
body.push(chunk);
}).on('end', () => {
body = Buffer.concat(body).toString();
// body 변수에는 문자열 형태로 payload가 담겨져 있습니다.
});
// [코드] Node.js로 HTTP 요청 body를 받는 코드-> Express v4.16.0 부터는 body-parser를 따로 설치 하지 않고, Express 내장 미들웨어인 express.json()을 사용
const jsonParser = express.json();
// 생략
app.post('/api/users', jsonParser, function (req, res) {
})
// [코드] express.json()을 이용한 코드express.json() 미들웨어 사용에 에러가 날 경우 options에 해답이 있다.
2: 모든 요청/응답에 CORS 헤더를 붙일 때
Node.js HTTP 모듈을 이용한 코드에 CORS 헤더를 붙일 때 : 응답 객체의 writeHead 메서드를 이용하여 라우팅마다 헤더를 매번 넣어주고 OPTIONS 메서드에 대한 라우팅도 따로 구현해야 함
const defaultCorsHeader = {
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
'Access-Control-Allow-Headers': 'Content-Type, Accept',
'Access-Control-Max-Age': 10
};
// 생략
if (req.method === 'OPTIONS') {
res.writeHead(201, defaultCorsHeader);
res.end()
}
// [코드] Node.js에 CORS를 적용하는 예시-> cors 미들웨어는 이 과정을 간단하게 처리
npm install cors
// 1. [코드] npm으로 cors를 설치
//--------------------------------//
const cors = require('cors');
// 생략
app.use(cors());
// 2. [코드] 모든 요청에 대해 CORS 허용
//--------------------------------//
const cors = require('cors')
// 생략
app.get('/products/:id', cors(), function (req, res, next) {
res.json({msg: 'This is CORS-enabled for a Single Route'})
})
// 3. [코드] 특정 요청에 대해 CORS 허용3: 모든 요청에 대해 url이나 메서드를 확인할 때
endpoint가 /이면서 클라이언트로부터 GET요청을 받았을 때 적용되는 미들웨어 구성 ⬇️
파라미터 순서에 유의해야 한다.
특정 endpoint가 아니라 모든 요청에 동일한 미들웨어를 적용하려면
-> 메서드 app.use를 사용한다.
const express = require('express');
const app = express();
const myLogger = function (req, res, next) {
console.log('LOGGED');
next();
};
app.use(myLogger);
app.get('/', function (req, res) {
res.send('Hello World!');
});
app.listen(3000);
// [코드] use 메서드로 모든 요청에 대하여 미들웨어를 적용모든 요청에 대해 메서드와 url을 출력하는 예시⬇️
const express = require('express');
const app = express();
const myLogger = function (req, res, next) {
//req를 활용합니다.
next();
};
app.use(myLogger);
app.get('/', function (req, res) {
res.send('Hello World!');
});
app.listen(3000);4: 요청 헤더에 사용자 인증 정보가 담겨있는지 확인할 때
HTTP 요청에서 토큰이 있는지를 판단하여, 이미 로그인한 사용자일 경우 성공, 아닐 경우 에러를 보내는 미들웨어 예제
app.use((req, res, next) => {
// 토큰이 있는지 확인, 없으면 받아줄 수 없음.
if(req.headers.token){
req.isLoggedIn = true;
next();
} else {
res.status(400).send('invalid user')
}
})