- CORS 동작 방식
- CORS 설정 방법
- node.js를 이용하여 서버 구축하기
같은 JavaScript를 사용하지만 node.js 환경에서 사용하는 코드에는, CommonJS나 모듈 등 브라우저에서 찾아볼 수 없는 다소 생소한 개념이 포함되어 있다. node.js에서 사용하는 이 개념들은 백엔드뿐만 아니라, 프론트엔드에서도 적극 사용한다.
- API 서버는 프론트엔드 개발자라도 구현할 수 있어야 한다.
- 새로운 서비스를 만들려고 해도, 필요한 데이터를 저장하거나 불러오는 기본적인 API 서버를 구현할 수 없다면 아무런 동적 활동을 할 수 없는 클라이언트만 구현하게 될 것이다.
- node.js에 대한 내용은 프론트엔트와 백엔드 등 웹 개발에서 공통적으로 사용하므로 반드시 알아야 한다.
CORS 에러
웹 개발을 하다 보면, 이 에러를 적어도 한 번쯤은 겪게 된다.
- 바로
CORS 에러이다.
CORS가 대체 뭐길래 이런 에러를 띄우는 건지 알아보기 전에, CORS가 필요하게 된 배경인 SOP에 대해서 먼저 알아보자.
SOP
SOP은 Same-Origin Policy의 줄임말로, 동일 출처 정책을 뜻한다.
- 즉, 같은 출처의 리소스만 공유가 가능하다.
- 여기서 말하는 ‘출처(Origin)’는 다음과 같다.
출처는 프로토콜, 호스트, 포트의 조합으로 되어있다. 이 중 하나라도 다르면 동일한 출처로 보지 않는다.
https://www.codestates.comvshttp://www.codestates.com
⇒ 두 URI는 프로토콜이 다르기 때문에 동일 출처가 아니다. ( https / http )
https://urclass.codestates.comvshttps://codestates.com
⇒ 두 URI는 호스트가 다르기 때문에 동일 출처가 아니다. ( urclass.codestates.com / codestates.com )
http://codestates.com:81 vs http://codestates.com
: http 프로토콜의 기본 포트는 80이다. 따라서http://codestates.com는http://codestates.com:80과 동일하다.
⇒ 두 URI는 포트가 다르기 때문에 동일 출처가 아니다. ( :81 / :80 )
https://codestates.com:443 vs https://codestates.com
: https 프로토콜의 기본 포트는 443이다. 따라서https://codestates.com는https://codestates.com:443과 동일하다.
⇒ 두 URI는 프로토콜, 호스트, 포트가 모두 같은 동일 출처이다.
SOP은 왜 생겨났을까?
- 동일 출처 정책은 잠재적으로 해로울 수 있는 문서를 분리함으로써 공격받을 수 있는 경로를 줄여준다.
- SOP을 통해 해킹 등의 위협에서보다 더 안전해질 수 있다.
왜 그런지 알아보기 위해서 동일 출처 정책이 없는 상황을 가정해보자.
- 네이버 같은 웹 페이지에 로그인해서 서비스를 이용하고 있을 때, 서비스 이용 중이 아니더라도 로그아웃을 깜빡했거나 자동 로그인 기능으로 인해 브라우저에 로그인 정보가 남아있을 수도 있다.
- 그 상태에서 로그인 정보를 노리는 코드가 있는 다른 사이트에 방문하게 된다면?
- 해커는 로그인 정보를 이용해서 네이버에서 사용할 수 있는 모든 기능을 이용할 수 있게 된다. 나도 모르는 사이에 내 계정으로 블로그나 카페에 좋지 않은 글을 올리게 될 수도, 수천 명에게 스팸 메일을 보낼 수도 있는 것이다.
SOP이 있었다면 어땠을까?
- SOP은 애초에 다른 사이트와의 리소스 공유를 제한한다.
- 덕분에 로그인 정보가 타 사이트의 코드에 의해서 새어나가는 것을 방지할 수 있다.
- 이러한 보안상 이점 때문에 SOP은 모든 브라우저에서 기본적으로 사용하고 있는 정책이다.
BUT!!
그런데, 다른 출처의 리소스를 사용하게 될 일은 너무나도 많다.
- 당장 로컬 환경에서 개발할 때에도 클라이언트와 서버를 따로 개발하게 된다면 둘은 출처가 달라진다.
- 개발 중인 웹 사이트에서 네이버 지도 api를 사용하고 싶다면? github 정보를 받아와서 사용하고 싶다면?
- 모두 다른 출처의 리소스를 사용해야 하는 일이다.
- 하지만, 말했듯 모든 브라우저는 기본적으로 SOP 정책을 사용하고 있다.
- 어떻게 하면 다른 출처의 리소스를 받아올 수 있을까?
CORS
위 문제 상황에서 필요한 것이 바로 CORS 이다.
- CORS는 Cross-Origin Resource Sharing의 줄임말로 교차 출처 리소스 공유를 뜻한다.
- MDN에서는 CORS를 다음과 같이 정의하고 있다.
교차 출처 리소스 공유(Cross-Origin Resource Sharing, CORS)는
추가 HTTP 헤더를 사용하여,
한 출처에서 실행 중인 웹 애플리케이션이 다른 출처의 선택한 자원에 접근할 수 있는 권한을 부여하도록
브라우저에 알려주는 체제이다.
즉, 브라우저는 SOP에 의해 기본적으로 다른 출처의 리소스 공유를 막지만, CORS를 사용하면 접근 권한을 얻을 수 있게 되는 것이다.
다시 처음에 봤던 에러를 다시 한번 살펴보면,
이 에러를 쉽고 친절하게 풀어서 쓰면 다음과 같을 것이다.
다른 출처의 리소스를 가져오려고 했지만 SOP 때문에 접근이 불가능합니다.
CORS 설정을 통해 서버의 응답 헤더에 ‘Access-Control-Allow-Origin’을 작성하면 접근 권한을 얻을 수 있습니다.
즉, 이 에러는 CORS 때문이 아니라, SOP 때문이다.
CORS는 오히려 이 에러를 해결해줄 수 있는 방안이었던 것이다!
CORS 동작 방식
CORS의 동작 방식에는 크게 세 가지가 있다.
1. 프리플라이트 요청 (Preflight Request)
실제 요청을 보내기 전, OPTIONS 메서드로 사전 요청을 보내 해당 출처 리소스에 접근 권한이 있는지부터 확인하는 것을 프리플라이트 요청이라고 한다.
위 이미지의 흐름과 같이, 브라우저는 서버에 실제 요청을 보내기 전에 프리플라이트 요청을 보내고,
응답 헤더의 Access-Control-Allow-Origin으로 요청을 보낸 출처가 돌아오면 실제 요청을 보내게 된다.
만약에 요청을 보낸 출처가 접근 권한이 없다면 브라우저에서 CORS 에러를 띄우게 되고, 실제 요청은 전달되지 않는다.
프리플라이트 요청은 왜 필요한 걸까?
- 프리플라이트 요청은 실제 요청을 보내기 전에 미리 권한 확인을 할 수 있기 때문에, 권한이 없는 요청을 미리 거를 수 있다.
- 실제 요청을 보내기 전에 미리 권한 확인을 할 수 있기 때문에, 실제 요청을 처음부터 통째로 보내는 것보다 리소스 측면에서 효율적이다.
- 프리플라이트 요청을 했을 때, 접근 권한이 없는 경우 CORS 에러가 나기 때문에 실제 요청을 불필요하게 보내지 않아도 된다.
- 응답 헤더의 Access-Control-Allow-Origin로 출처가 허용되면 실제 요청을 보낸다.
- CORS에 대비가 되어있지 않은 서버를 보호할 수 있다.
- CORS 이전에 만들어진 서버들은 SOP 요청만 들어오는 상황을 고려하고 만들어졌다.
- 따라서 다른 출처에서 들어오는 요청에 대한 대비가 되어있지 않았다.
- 이런 서버에 바로 요청을 보내면, 응답을 보내기 전에 우선 요청을 처리하게 된다.
- 브라우저는 응답을 받은 후에야 CORS 권한이 없다는 것을 인지하지만, 브라우저가 에러를 띄운 후에는 이미 요청이 수행된 상태가 된다.
- 만약에 들어온 요청이 DELETE 나 PUT 처럼 서버의 정보를 삭제하거나 수정하는 요청이었다면? 😨
- 하지만 CORS에 대비가 되어있지 않은 서버라도 프리플라이트 요청을 먼저 보내게 되면, 프리플라이트 요청에서 CORS 에러를 띄우게 된다.
- 예시와 같이 실행돼선 안 되는 Cross-Origin 요청이 실행되는 것을 방지할 수 있는 것이다.
- 이런 이유로 프리플라이트 요청이 CORS의 기본 사양으로 들어가게 되었다.
2. 단순 요청 (Simple Request)
단순 요청은 특정 조건이 만족되면 프리플라이트 요청을 생략하고 요청을 보내는 것을 말한다.
조건은 다음과 같다. (하지만 이 조건들을 모두 만족시키기는 어려우므로, 일단은 참고만 한다.)
- GET, HEAD, POST 요청 중 하나여야 한다.
- 자동으로 설정되는 헤더 외에, Accept, Accept-Language, Content-Language, Content-Type 헤더의 값만 수동으로 설정할 수 있다.
- Content-Type 헤더에는 application/x-www-form-urlencoded, multipart/form-data, text/plain 값만 허용된다.
3. 인증정보를 포함한 요청 (Credentialed Request)
요청 헤더에 인증 정보를 담아 보내는 요청이다. 출처가 다를 경우에는 별도의 설정을 하지 않으면 쿠키를 보낼 수 없다. 민감한 정보이기 때문이다. 이 경우에는 프론트, 서버 양측 모두 CORS 설정이 필요하다.
- 프론트 측에서는 요청 헤더에 withCredentials : true 를 넣어줘야 한다.
- 서버 측에서는 응답 헤더에 Access-Control-Allow-Credentials : true 를 넣어줘야 한다.
- 서버 측에서 Access-Control-Allow-Origin 을 설정할 때, 모든 출처를 허용한다는 뜻의 와일드카드(*)로 설정하면 에러가 발생한다. 인증 정보를 다루는 만큼 출처를 정확하게 설정해주어야 한다.
CORS 설정 방법
CORS는 서버에서 중요하게 다루는 개념으로 Node.js 뿐만 아니라 Express, Fastify 등 다른 서버 환경에서도 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");
})
예)
클라이언트 http://localhost:1234에서 POST 요청을 보낼 시 CORS 에러가 발생하지 않는다.
클라이언트 http://localhost:3000에서 POST 요청을 보낼 시 CORS 에러가 발생한다.
서버에서 http://localhost:1234에 대하여 CORS를 허용하고 있다.
const http = require('http');
const PORT = 4999;
const ip = 'localhost';
const server = http.createServer((request, response) => {
console.log(
`http request method is ${request.method}, url is ${request.url}`
);
response.writeHead(200, defaultCorsHeader);
response.end('hello quizsets');
});
server.listen(PORT, ip, () => {
console.log(`http server listen on ${ip}:${PORT}`);
});
const defaultCorsHeader = {
'Access-Control-Allow-Origin': 'http://localhost:1234',
'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
'Access-Control-Allow-Headers': 'Content-Type, Accept',
'Access-Control-Max-Age': 10
};
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" });
});
이 외 다양한 개발 환경에서도, 헤더의 값을 설정하는 방법만 알면 CORS 설정을 해줄 수 있다.
'FE > Network' 카테고리의 다른 글
[Network] Express의 미들웨어(Middleware) (0) | 2023.04.05 |
---|---|
(비)[Network] HTTP모듈을 Express로 리팩토링 (0) | 2023.04.05 |
[Network] Effect Hook & Ajax 요청 (0) | 2023.04.01 |
[Network] Postman으로 HTTP 요청 및 응답 받아오기 (0) | 2023.03.30 |
[Network] Open API란? (0) | 2023.03.30 |