<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Tim Kang on Medium]]></title>
        <description><![CDATA[Stories by Tim Kang on Medium]]></description>
        <link>https://medium.com/@selenehyun?source=rss-305e129bdd9a------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/2*5v8-NFuBa6UuashHBSRZng.jpeg</url>
            <title>Stories by Tim Kang on Medium</title>
            <link>https://medium.com/@selenehyun?source=rss-305e129bdd9a------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Sat, 21 Nov 2026 15:05:23 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@selenehyun/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[koa.js 와 Joi/Zod Schema를 이용한 API 문서 관리 자동화: koa-x-router]]></title>
            <link>https://medium.com/ecube-labs/koa-js-%EC%99%80-joi-zod-schema%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%9C-api-%EB%AC%B8%EC%84%9C-%EA%B4%80%EB%A6%AC-%EC%9E%90%EB%8F%99%ED%99%94-koa-x-router-53c68107685f?source=rss-305e129bdd9a------2</link>
            <guid isPermaLink="false">https://medium.com/p/53c68107685f</guid>
            <category><![CDATA[koajs]]></category>
            <category><![CDATA[nodejs]]></category>
            <category><![CDATA[router]]></category>
            <category><![CDATA[open-api]]></category>
            <category><![CDATA[swagger]]></category>
            <dc:creator><![CDATA[Tim Kang]]></dc:creator>
            <pubDate>Thu, 17 Oct 2024 05:30:27 GMT</pubDate>
            <atom:updated>2024-10-17T05:30:27.245Z</atom:updated>
            <content:encoded><![CDATA[<p>API를 개발할 때 데이터를 검증하고 문서를 작성하는 것은 매우 중요합니다. 하지만 이 작업을 수작업으로 하면 시간이 많이 들고 실수하기 쉽습니다. 오늘 소개할 <strong>koa-x-router</strong>는 Node.js와 Koa.js를 사용하여 이런 문제를 쉽게 해결할 수 있는 도구입니다. 이 글에서는 koa-x-router의 주요 기능과 장점, 그리고 사용 방법을 설명해 드리겠습니다.</p><h3>왜 API 문서와 데이터 검증이 중요한가요?</h3><p>API를 만들 때, 사용자가 보내는 데이터가 올바른지 확인하는 것이 중요합니다. 잘못된 데이터가 시스템에 들어오면 서비스의 품질이 떨어지거나 보안 문제가 발생할 수 있습니다.<br>예를 들어, 올바르지 않은 데이터가 서버로 들어오면 시스템 오류나 보안 취약점이 생길 수 있습니다. 그래서 API가 받는 데이터와 내보내는 데이터를 검증하는 것이 필수적입니다.</p><p>또한, API를 사용하는 사람들이 쉽게 이해할 수 있도록 <strong>API 문서</strong>를 제공하는 것이 중요합니다. API 문서는 다른 개발자들이 API를 올바르게 이해하고 사용할 수 있게 도와줍니다. 하지만 API가 자주 업데이트되다 보니, 문서를 최신 상태로 유지하는 것이 어려울 때가 많습니다. 문서와 실제 코드가 맞지 않으면 개발 속도가 느려지고, 오류가 발생할 가능성이 높아집니다.</p><p><strong>koa-x-router</strong>는 이러한 문제를 해결하기 위해 <strong>자동 데이터 검증</strong>과 <strong>자동 문서화</strong> 기능을 제공합니다. 이 덕분에 API 개발이 더 쉬워지고, 유지보수도 편리해집니다.</p><h3>koa-x-router란?</h3><p><strong>koa-x-router</strong>는 Koa.js 환경에서 동작하는 라이브러리로, 기존의 <strong>koa-router</strong>를 확장하여 사용합니다. 이 라이브러리는 API의 <strong>입력과 출력 데이터를 검증</strong>하고, <strong>OpenAPI 문서</strong>를 자동으로 생성해줍니다. 이를 통해 Koa.js를 사용하는 API 개발이 더욱 편리하고 효율적으로 이루어집니다. koa-x-router는 개발자들이 더 신뢰할 수 있는 API를 만들 수 있도록 도와주고, 문서 작성 작업을 자동화하여 개발 속도를 높여줍니다.</p><p>이 도구는 <strong>어댑터 패턴</strong>을 사용하여 다양한 검증 도구를 사용할 수 있게 설계되었습니다. 현재 <strong>Joi</strong>와 <strong>Zod</strong>를 사용할 수 있지만, 원하는 다른 검증 도구도 쉽게 추가할 수 있습니다. 어댑터 패턴의 장점은 특정 검증 도구에 종속되지 않고, 필요에 따라 검증 도구를 쉽게 교체하거나 확장할 수 있다는 점입니다. 프로젝트의 요구가 변화하거나 새로운 검증 도구가 필요할 때 유연하게 대처할 수 있습니다.</p><h3>주요 기능</h3><ul><li><strong>데이터 검증</strong>: 다양한 검증 도구를 사용해 API의 입력과 출력 데이터를 확인할 수 있습니다. 이를 통해 잘못된 데이터가 시스템에 유입되는 것을 방지할 수 있습니다.</li><li><strong>OpenAPI 문서 자동 생성</strong>: 검증에 사용된 스키마를 바탕으로 OpenAPI 문서를 자동으로 생성합니다. 이렇게 하면 항상 최신 상태의 API 문서를 유지할 수 있습니다.</li><li><strong>유연한 어댑터 패턴</strong>: 원하는 검증 도구를 쉽게 추가할 수 있어 프로젝트에 맞는 도구를 선택할 수 있습니다.</li></ul><h3>koa-x-router의 장점</h3><ol><li><strong>문서 자동 생성</strong>: API 문서를 자동으로 생성하여 코드와 문서가 항상 일치하도록 합니다. 이렇게 하면 개발자가 문서를 따로 작성할 필요가 없어집니다.</li><li><strong>검증 도구 선택의 자유</strong>: Joi와 Zod뿐만 아니라 원하는 검증 도구를 어댑터 코드만 작성하면 사용할 수 있습니다. 이를 통해 프로젝트에 맞는 검증 도구를 쉽게 선택하고 교체할 수 있습니다.</li><li><strong>기존 코드 최소 수정</strong>: 기존에 <strong>koa-router</strong>를 사용하고 있었다면, 이를 <strong>koa-x-router</strong>로 간단히 바꿀 수 있습니다. 기존 코드를 대부분 그대로 사용할 수 있기 때문에 큰 수정 없이 쉽게 적용할 수 있습니다.</li></ol><h3>데모와 시작하기</h3><p>koa-x-router의 기능을 직접 확인해 보고 싶다면, <a href="https://github.com/Ecube-Labs/koa-x-router">GitHub 페이지</a>에서 데모와 설치 방법을 확인할 수 있습니다. 아래에서는 간단히 프로젝트에 적용하는 방법을 설명하겠습니다. 데모를 통해 koa-x-router가 제공하는 기능을 직접 경험해 보세요.</p><iframe src="https://cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fstackblitz.com%2Fedit%2Fkoa-x-router-demo%3Fembed%3D1%26file%3Droutes%252Fusers%252Findex.ts&amp;display_name=StackBlitz&amp;url=https%3A%2F%2Fstackblitz.com%2Fedit%2Fkoa-x-router-demo%3Fembed%3D1%26file%3Droutes%252Fusers%252Findex.ts&amp;image=https%3A%2F%2Fsocial-img.staticblitz.com%2Fprojects%2Fkoa-x-router-demo%2Ff2e1589f9fdd1d2a1322b1dfe9bbb1bf&amp;key=a19fcc184b9711e1b4764040d3dc5c07&amp;type=text%2Fhtml&amp;schema=stackblitz" width="745" height="400" frameborder="0" scrolling="no"><a href="https://medium.com/media/2e651cff019ede7761ce61f2d06a1905/href">https://medium.com/media/2e651cff019ede7761ce61f2d06a1905/href</a></iframe><h3>프로젝트에 적용하기</h3><h3>설치</h3><p>koa-x-router를 설치하려면 아래 명령어를 사용하세요:</p><pre>npm install koa @koa/router koa-x-router zod</pre><h3>TypeScript를 사용하는 경우 추가 설치</h3><pre>npm install @types/koa @types/koa__router -D</pre><p>설치가 완료되면 프로젝트에 쉽게 통합할 수 있습니다.</p><h3>기존 koa-router 코드 대체하기</h3><p>기존의 <strong>@koa/router</strong> 코드를 <strong>koa-x-router</strong>로 대체하는 것은 매우 간단합니다. 기존의 라우터 코드에서 koa-x-router를 가져와 사용하면 됩니다. 이렇게 하면 기존 코드를 많이 수정하지 않아도 되고, koa-x-router의 기능을 쉽게 사용할 수 있습니다.</p><h3>ZodAdaptor 사용 예시</h3><p>아래는 <strong>ZodAdaptor</strong>를 사용해 데이터를 검증하는 예시입니다. 이를 통해 koa-x-router의 검증 기능을 쉽게 사용할 수 있습니다:</p><pre>import { ZodAdaptor, Router } from &#39;koa-x-router&#39;;<br>import { z } from &#39;zod&#39;;<br><br>const userRouter = new Router({<br>  adaptors: [ZodAdaptor],<br>});<br>userRouter.prefix(&#39;/users&#39;);<br><br>userRouter.add([<br>  {<br>    method: &#39;post&#39;,<br>    path: &#39;/&#39;,<br>    meta: {<br>      document: {<br>        summary: &#39;Create User&#39;, // &lt;= 문서에 노출될 API의 이름<br>      },<br>    },<br>    validate: {<br>      body: z.object({ // &lt;= API의 <br>        name: z.string(),<br>      }),<br>      output: { // &lt;= API의 응답 형식<br>        200: {<br>          body: z.array(<br>            z.object({<br>              name: z.string(),<br>              age: z.number(),<br>            })<br>          ),<br>        },<br>      },<br>    },<br>    handler: async (ctx) =&gt; {<br>      ctx.status = 201;<br>      ctx.body = `Created`;<br>    },<br>  },<br>]);</pre><p>이 예시에서는 사용자가 입력한 <strong>name</strong>과 <strong>age</strong>를 검증하고, 결과로 <strong>success</strong> 값을 반환합니다. 이렇게 하면 API가 받는 데이터와 내보내는 데이터가 규칙에 맞는지 쉽게 확인할 수 있습니다.</p><h3>OpenAPI 문서 생성 확인</h3><p>koa-x-router는 자동으로 OpenAPI 문서를 생성해줍니다. 이 문서를 통해 API가 어떻게 동작하는지, 어떤 데이터를 받는지, 어떤 응답을 주는지 쉽게 확인할 수 있습니다.</p><pre>rootRouter.get(&#39;/openapi.json&#39;, (ctx) =&gt; {<br>  ctx.body = apiRouter.generateOpenApiSpecJson({<br>    info: {<br>      title: &#39;koa-x-router Demo API Docs&#39;,<br>      version: &#39;1.0.0&#39;,<br>    },<br>  }); // &lt;= stringified JSON data<br>});</pre><pre>curl http://localhost:3000/openapi.json<br><br>{<br>    &quot;info&quot;: {<br>        &quot;title&quot;: &quot;koa-x-router Demo API Docs&quot;,<br>        &quot;version&quot;: &quot;1.0.0&quot;,<br>...</pre><h3>OpenAPI 문서 시각화하기</h3><p>생성된 OpenAPI 문서는 Swagger UI와 같은 도구를 사용해 시각적으로 볼 수 있습니다. Swagger UI를 사용하면 브라우저에서 API의 모든 엔드포인트를 탐색하고 테스트해 볼 수 있습니다. 이렇게 하면 개발자뿐만 아니라 팀원들도 API를 쉽게 이해하고 사용할 수 있습니다.</p><p>아래는 <a href="https://github.com/Redocly/redoc">redoc</a> 을 이용한 간단한 시각화 예시입니다:</p><pre>rootRouter.get(&#39;/docs&#39;, (ctx) =&gt; {<br>  ctx.body = `&lt;!DOCTYPE html&gt;<br>  &lt;html&gt;<br>  &lt;head&gt;<br>    &lt;meta charset=&quot;UTF-8&quot;&gt;<br>    &lt;meta name=&quot;viewport&quot; content=&quot;width=device-width, initial-scale=1.0&quot;&gt;<br>    &lt;meta http-equiv=&quot;X-UA-Compatible&quot; content=&quot;ie=edge&quot;&gt;<br>    &lt;title&gt;API Documentation&lt;/title&gt;<br>    &lt;link href=&quot;https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700&quot; rel=&quot;stylesheet&quot;&gt;<br>    &lt;style&gt;body{margin: 0;padding: 0;}&lt;/style&gt;<br>  &lt;/head&gt;<br>  &lt;body&gt;<br>    &lt;redoc spec-url=&#39;/openapi.json&#39; lazy-rendering&gt;&lt;/redoc&gt;<br>    &lt;script src=&quot;https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js&quot;&gt;&lt;/script&gt;<br>  &lt;/body&gt;<br>  &lt;/html&gt;`;<br>});<br><br>rootRouter.get(&#39;/openapi.json&#39;, (ctx) =&gt; {<br>  ctx.body = apiRouter.generateOpenApiSpecJson({<br>    info: {<br>      title: &#39;koa-x-router Demo API Docs&#39;,<br>      version: &#39;1.0.0&#39;,<br>    },<br>  });<br>});</pre><h3>호환성</h3><p>koa-x-router는 Koa.js를 기반으로 동작하며, Node.js 환경에서 잘 사용할 수 있습니다. 다양한 검증 도구와 쉽게 통합되기 때문에 기존 코드에 큰 수정 없이 적용할 수 있습니다. 이렇게 하면 기존 Koa.js 기반 코드와의 호환성을 유지하면서도 새로운 기능을 사용할 수 있습니다.</p><p>또한 koa-x-router는 최신 Koa.js 버전과 호환되며, 다양한 Node.js 환경에서 테스트되었습니다. 이를 통해 안정적인 API 개발을 지원하고, 다양한 프로젝트에 쉽게 적용할 수 있습니다.</p><h3>결론</h3><p><strong>koa-x-router</strong>는 Koa.js를 사용하는 개발자에게 매우 유용한 도구입니다. 이 도구를 사용하면 데이터 검증과 문서 생성을 자동으로 처리할 수 있어, 개발 시간을 절약하고 유지보수를 쉽게 할 수 있습니다. 이를 통해 API의 신뢰성과 보안을 높이고, 문서 작성에 드는 시간을 줄여 중요한 개발 작업에 집중할 수 있습니다.</p><p>koa-x-router를 프로젝트에 적용해서 API 개발의 품질과 효율성을 높여보세요. 이를 통해 더 좋은 API를 만들고, 팀 전체의 개발 경험을 개선할 수 있습니다.</p><p>더 자세한 정보와 사용 방법은 <a href="https://github.com/Ecube-Labs/koa-x-router">GitHub 페이지</a>를 참고하세요.</p><p><a href="https://github.com/Ecube-Labs/koa-x-router">GitHub - Ecube-Labs/koa-x-router: `koa-x-router` is a library that extends the functionality of `@koa/router` by providing validation and automatic API documentation features. It simplifies the process of defining routes, validating request data, and generating API documentation.</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=53c68107685f" width="1" height="1" alt=""><hr><p><a href="https://medium.com/ecube-labs/koa-js-%EC%99%80-joi-zod-schema%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%9C-api-%EB%AC%B8%EC%84%9C-%EA%B4%80%EB%A6%AC-%EC%9E%90%EB%8F%99%ED%99%94-koa-x-router-53c68107685f">koa.js 와 Joi/Zod Schema를 이용한 API 문서 관리 자동화: koa-x-router</a> was originally published in <a href="https://medium.com/ecube-labs">Ecube Labs</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[[JS] Hoisting]]></title>
            <link>https://medium.com/ecube-labs/js-hoisting-c105b163f1bf?source=rss-305e129bdd9a------2</link>
            <guid isPermaLink="false">https://medium.com/p/c105b163f1bf</guid>
            <category><![CDATA[hoisting]]></category>
            <category><![CDATA[javascript]]></category>
            <dc:creator><![CDATA[Tim Kang]]></dc:creator>
            <pubDate>Fri, 12 Nov 2021 03:55:55 GMT</pubDate>
            <atom:updated>2021-11-12T03:55:55.542Z</atom:updated>
            <content:encoded><![CDATA[<p>자바스크립트 개발자들은 var 키워드를 사용해 변수를 선언하면 안된다고 한다. <br>다들 이렇게 말하는 이유는 Hoisting(이하 호이스팅) 때문이다.</p><p>그러면 const, let은 호이스팅의 대상이 아니기 때문에 괜찮은걸까?<br>이것을 자세히 알아보기 전에 호이스팅이 일어나면 어떤 상황이 발생하는지 예시를 통해 살펴보자.</p><h3>호이스팅 발생 예시</h3><h4>선언되지 않은 변수를 참조하는 경우: 호이스팅 X</h4><pre>console.log(typeof variable); // 출력: undefined</pre><pre>console.log(variable); // 출력: ReferenceError: variable is not defined</pre><pre>const variable = &#39;Test&#39;;</pre><p>선언되지 않은 변수의 타입은 항상 undefined 이며, 이러한 변수를 참조하는 순간 ReferenceError 라는 이름의 에러가 발생한다.</p><h4>선언되지 않은 변수를 참조하는 경우: 호이스팅 O</h4><pre>console.log(typeof variable); // 출력: undefined</pre><pre>console.log(variable); // 출력: undefined</pre><pre>var variable = &#39;Test&#39;;</pre><p>아직 선언되지 않은 변수를 참조해도 undefined를 뱉을 뿐, 예상했던 참조 에러가 발생하지 않는다.<br>이렇듯 예상한것과 다르게 동작하는 순간 개발자의 코드는 어딘가 잘못 되어갈 가능성이 매우 높으며, 호이스팅 된 변수의 내용이 같은 이름을 사용하는 다른 코드에 의해 의도치 않게 변경되어 아주 힘든 디버깅 시간을 보내게 될것이다.</p><p>어떻게 이런 상황이 발생할 수 있는지 알아보기 위해서는 자바스크립트의 라이프 사이클 일부를 살펴봐야 한다.</p><h3>호이스팅은 왜 생겨날까?</h3><p>자바스크립트의 변수 라이프사이클을 살펴보면 알 수 있다.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/864/1*aejqYc498n8UxaLP0MmTig.png" /><figcaption>출처: <a href="https://dmitripavlutin.com/variables-lifecycle-and-why-let-is-not-hoisted/">https://dmitripavlutin.com/variables-lifecycle-and-why-let-is-not-hoisted/</a></figcaption></figure><p>자바스크립트에서 변수의 라이프사이클은 크게 선언, 초기화, 할당의 단계를 거친다.</p><p>이 중 선언 단계에서 코드에 선언된 모든 변수, 함수, 클래스 선언은 변수처럼 선언 처리가 된다. 이후 실행 단계에서 할당 코드를 만났을때 선언 되었던 변수나 함수, 클래스에 값이 들어간다.</p><p>단, var 키워드로 선언된 변수는 선언과 동시에 초기화도 진행되기 때문에 호이스팅이 되는것이다. 그렇기 때문에 우리가 변수의 값을 미리 조회 했을 때 undefined를 볼 수 있는것이다.</p><h3>그럼 const, let은 왜 호이스팅의 대상이 아닌가?</h3><p>사실 자바스크립트에서는 선언하는 거의 대부분의 변수, 함수, 클래스 선언이 호이스팅의 대상이 된다.</p><p>일부 개발자들이 var 만 호이스팅의 대상이라고 말하는것은 TDZ라는 개념이 존재하기 때문에 사실처럼 보이는것 뿐이다. TDZ에 대해서는 조금 뒤에 자세히 알아보자.</p><h3>선언 전에 사용하면 참조 에러가 나던데?</h3><p>앞서 말했듯 const, let으로 선언한 변수나 함수, 클래스도 호이스팅된다.</p><p>그러나 함수와 달리 클래스는 const 처럼 평가되기 전까지는 초기화되지 않고 TDZ에 속하므로 사용할 수 없다.</p><pre>const Tim = new Person(200, 100); // ReferenceError: Person is not defined<br>Tim.weight = 90;<br>console.log(Tim);</pre><pre>class Person {<br>  constructor(height, weight) {<br>    this.height = height;<br>    this.weight = weight;<br>  }<br>}</pre><p>그렇기 때문에 위의 코드에서 Person을 참조해도 undefined를 참조하지 않고 참조 에러가 발생 하는것이다. 이 특징은 클래스 선언, 클래스 표현식 모두 해당된다.</p><p>TDZ의 존재 덕분에 위 코드를 제대로 동작하게 하려면 당연히 아래처럼 작성하게 된다.</p><pre>class Person {<br>  constructor(height, weight) {<br>    this.height = height;<br>    this.weight = weight;<br>  }<br>}</pre><pre>const Tim = new Person(200, 100);<br>Tim.weight = 90;<br>console.log(Tim);</pre><pre>// Print: Person {height: 200, weight: 90}</pre><h3><a href="https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Statements/let#%EC%8B%9C%EA%B0%84%EC%83%81_%EC%82%AC%EA%B0%81%EC%A7%80%EB%8C%80">TDZ</a>가 도대체 뭐길래?</h3><p>TDZ(Temporal Dead Zone)는 선언문을 만나 초기화가 완료되기 전까지 변수를 참조하면 참조 에러를 발생시키는 역할을 한다.</p><p>모든 선언은 TDZ에 속할 수 있지만, var로 선언된 변수는 선언과 동시에 무조건 undefined 값으로 초기화 하기 때문에 TDZ에 속하지 않는것처럼 동작한다.</p><p>이 개념을 이해한다면 그동안 let, const, class 선언은 왜 호이스팅이 일어나지 않는지 이해할 수 있다.</p><p>때문에 TDZ와 블록 스코프를 알고 있다면 아래의 예시에서 에러가 발생하는게 당연하다고 여길수 있게 된다.</p><h3>직접 눈으로 확인해보자</h3><p>호이스팅이 되는것은 아래의 예시와 함께 VSC의 디버거로 손쉽게 확인해 볼 수 있다.</p><h4>var로 선언한 경우</h4><pre>debugger; // 모든 코드를 읽어 초기화 된 상태</pre><pre>myFn(); // Output: &quot;TypeError: myFn is not a function&quot;</pre><pre>var myFn = function () {<br>  console.log(&quot;Will this work?&quot;);<br>};</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*7Q1joXuRB7lIgglLZjE-hA.png" /></figure><p>var로 선언한 myFn은 호이스팅이 일어나 초기화가 끝난 상태에서 undefined로 초기화 된것을 볼 수 있다.</p><p>그 증거로 myFn() 를 평가하면 발생하는 에러 메세지가 아래와 같다. Uncaught TypeError: myFn is not a function</p><h4>const로 선언한 경우</h4><pre>debugger; // 모든 코드를 읽어 초기화 된 상태</pre><pre>myFn(); // Output: &quot;Uncaught ReferenceError: Cannot access &#39;myFn&#39; before initialization&quot;</pre><pre>const myFn = function () {<br>  console.log(&quot;Will this work?&quot;);<br>};</pre><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*rBN0kHprvKcyA0JUWTgyfg.png" /></figure><p>const로 선언할 때도 마찬가지로 myFn 변수도 호이스팅이 일어나 변수가 미리 선언된 것을 볼 수 있다.</p><p>실제로 선언되는 모든 변수는 undefined 가 기본 값이기 때문에 undefined 로 보이기는 하지만 초기화가 끝난 상태가 아닌 TDZ에 속한 상태이므로 아직 사용할 수 없다.</p><p>그 증거로 myFn() 를 평가하게 되면 아래와 같은 에러가 발생한다. Uncaught ReferenceError: Cannot access &#39;myFn&#39; before initialization</p><p>TDZ에 속해 있을 때 접근하면 발생하는 에러다.</p><h3>코드 검증</h3><p>실제로 Node.js가 의존하고 있는 V8 엔진의 코드를 보면 아래와 같다.</p><p><strong>메세지도 별도로 관리된다:</strong></p><pre>// 출처: <a href="https://github.com/nodejs/node/blob/842fd234b7634200ed55141fc77d4e96c3c593bd/deps/v8/src/common/message-template.h#L325">https://github.com/nodejs/node/blob/842fd234b7634200ed55141fc77d4e96c3c593bd/deps/v8/src/common/message-template.h#L325</a><br>/* ReferenceError */                                                         \ <br> T(NotDefined, &quot;% is not defined&quot;)                                            \ <br> T(SuperAlreadyCalled, &quot;Super constructor may only be called once&quot;)           \ <br> T(AccessedUninitializedVariable, &quot;Cannot access &#39;%&#39; before initialization&quot;)  \</pre><p><strong>변수 키워드에 따라 상태가 다르게 초기화 된다:</strong></p><pre>// 출처: https://github.com/nodejs/node/blob/e83c8aef4b787b531f23ad7abb498fe81db5ee83/deps/v8/src/ast/variables.h#L240-L244<br>static InitializationFlag DefaultInitializationFlag(VariableMode mode) {<br>    DCHECK(IsDeclaredVariableMode(mode));<br>    return mode == VariableMode::kVar ? kCreatedInitialized<br>                                      : kNeedsInitialization;</pre><p><a href="https://gyujincho.github.io/2018-06-19/AST-for-JS-devlopers"><strong>AST</strong></a><strong> 추출 시에도 var 를 검사 로직이 존재한다:</strong></p><pre>// 출처: <a href="https://github.com/nodejs/node/blob/e83c8aef4b787b531f23ad7abb498fe81db5ee83/deps/v8/src/ast/variables.h#L42-L44">https://github.com/nodejs/node/blob/e83c8aef4b787b531f23ad7abb498fe81db5ee83/deps/v8/src/ast/variables.h#L42-L44</a><br>// Var declared variables never need initialization. <br>    DCHECK(!(mode == VariableMode::kVar &amp;&amp; <br>             initialization_flag == kNeedsInitialization));</pre><h3>마무리</h3><ul><li>var를 사용하면 안되는 이유에 대해 논리적으로 이해할 수 있다.</li><li>TDZ 덕분에 우리는 호이스팅이 일어나지 않는 패턴으로 작성할 수 있게 된다.</li></ul><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=c105b163f1bf" width="1" height="1" alt=""><hr><p><a href="https://medium.com/ecube-labs/js-hoisting-c105b163f1bf">[JS] Hoisting</a> was originally published in <a href="https://medium.com/ecube-labs">Ecube Labs</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[LDAP에 대해 알아보자]]></title>
            <link>https://medium.com/ecube-labs/ldap%EC%97%90-%EB%8C%80%ED%95%B4-%EC%95%8C%EC%95%84%EB%B3%B4%EC%9E%90-4e5aecd358e3?source=rss-305e129bdd9a------2</link>
            <guid isPermaLink="false">https://medium.com/p/4e5aecd358e3</guid>
            <category><![CDATA[ldap-directories]]></category>
            <category><![CDATA[ldap-server]]></category>
            <category><![CDATA[directory-services]]></category>
            <category><![CDATA[ldap]]></category>
            <dc:creator><![CDATA[Tim Kang]]></dc:creator>
            <pubDate>Mon, 13 Apr 2020 23:23:36 GMT</pubDate>
            <atom:updated>2020-11-23T07:25:39.219Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*KiV6FgvZD4iCuq2-" /><figcaption>산맥같은 LDAP의 로고. 시작부터 험난한 여정을 예고하는듯 하다.</figcaption></figure><h3>개요</h3><p>갑자기 이큐브랩 솔루션에서 SSO가 필요해져 구현하게 되었습니다.<br>일반적으로 SSO를 구현하는 방법은 OAuth2나 SAML2를 사용하는것으로 보였습니다.<br>일단 SAML2를 지원하기 위해 찾아보니, LDAP와 같은 디렉터리 서비스가 필요했습니다.<br>그냥 오픈소스를 이용해 디렉터리 서비스를 마련해도 됐었지만, 얕더라도 LDAP에 대한 이해를 하기 위해 정리도 할 겸 이 글을 작성하게 되었습니다. (SSO에 대한 글은 너무 좋은 글들이 많아서 스킵…)</p><p>실제로 사용 가능하고 가벼운 LDAP 서버를 구현하는게 목표이고, 그 과정에 필요한 사전 지식들을 정리해보고자 합니다 😃</p><h3>LDAP가 뭐지?</h3><ul><li>Lightweight Directory Access Protocol 의 약자.</li><li>인터넷 기반 분산 디렉터리 서비스를 위한 프로토콜</li><li>디렉터리 서비스를 제공하기 위한 표준급(다들 쓰는?) 프로토콜</li></ul><p>위 항목을 보면 결국 LDAP는 프로토콜일 뿐, 보통 디렉터리 서비스를 제공하기 위해 사용하는것을 알 수 있습니다.</p><h3>History</h3><p>조금만 더 알아보겠습니다.<br>1993년 7월에 미시간 대학교를 주도로 디렉터리 접속 프로토콜인 LDAP가 만들어졌습니다.<br>더 정확히는 1993년 7월에 인터넷 표준으로 RFC1487가 제정됐습니다.</p><p>LDAP는 기존에 X.500에서 정의된 프로토콜의 한 종류인 DAP를 단순화 시킨 프로토콜입니다.<br>DAP는 OSI의 모든 레이어를 지원하며 운영에 많은 컴퓨팅 리소스를 필요로 하는 아주 무거운 프로토콜이라고 합니다.<br>그래서 더 가볍게 사용하기 위해 경량화 시킨것이죠.</p><h3>Lightweight?</h3><p>그런데 우리가 사용하려고 찾아보니 전혀 가벼워 보이지 않습니다.<br>그럼 어디가 가벼워졌다고 하는걸까요?<br>이 “Lightweight” 라는 의미는 프로토콜의 스펙을 말하는것은 아니었습니다.<br>오히려 DAP의 스펙은 최대한 유지하면서 네트워크의 부담을 최대한 줄인 버전이라고 봐야겠습니다.</p><p>스펙이 짱짱한것에 비해 네트워크의 부담이 적으니 30년이 지난 지금까지도 잘 사용되고 있는것이겠죠? 🙂</p><h3>그럼 디렉터리 서비스가 뭔데??</h3><p>디렉터리 모델은 꽤 오래전(30y+)부터 존재하고 있었습니다.<br>앞에서 말했듯 이 디렉터리 모델(정확히는 DAP)을 기반으로 구현된 LDAP는 미시간 대학교의 똑똑한 사람들이 다듬어서 새로운 규약으로 정리한것인데, 디렉터리 서비스는 이것을 이용해 계층적으로 데이터를 관리할 수 있도록 해주는 프로그램이라고 볼 수 있습니다. (like DBMS…)</p><p>지금은 대부분 기업의 사용자 정보를 Centralize하고, 수천 명의 사용자를 논리적 그룹으로 나누고 다른 시스템에서도 통합된 사용자 정보를 공유하는 용도로 많이 사용하고 있습니다.</p><p>정리하자면 사실상 트리 구조로 데이터를 담아두고, 찾기 쉬운것을 원한다면 어떤 데이터를 담아도 상관이 없습니다.<br>단지 적합한 용도로서 조직의 사용자나 주소록 정보를 관리하는것이 꼽히는것이죠.<br>그것을 목적으로 만들어진 프로토콜이니까요.</p><h4>그럼 데이터베이스랑 별로 다르지 않네?</h4><p>이것에 대해 <a href="https://ldap.com/basic-ldap-concepts/">LDAP에서</a>는 이렇게 설명하고 있습니다.</p><blockquote><em>디렉토리 서버 (보다 기술적으로는 Directory Server Agent, 디렉토리 시스템 에이전트 또는 DSA라고 함)는 항목 트리로 표시되는 정보를 저장하는 네트워크 데이터베이스 유형입니다. 이것은 행과 열로 구성된 테이블을 사용하는 관계형 데이터베이스와는 다르기 때문에 디렉토리 서버는 NoSQL이라는 용어보다 훨씬 오래 사용되었지만 디렉토리 서버는 NoSQL 데이터베이스 유형으로 간주 될 수 있습니다.</em></blockquote><p>여러 문서에서 디렉터리 서비스는 데이터베이스와 다르다고 말하지만, LDAP에서 공식적으로 “<em>네트워크 데이터베이스 유형”, “NoSQL 데이터베이스 유형으로 간주 될 수 있습니다.”</em> 라고 말합니다.</p><p>우리는 디렉터리 서비스(서버)를 네트워크 데이터베이스 서버라고 불러도 되겠네요 😄</p><h3>디렉터리 서비스가 왜 필요하지?</h3><p>위에서 언급한대로 기업같은 대규모 조직에서 사용자나 주소록 등의 정보를 중앙 집중화하여 관리하기 위해 사용합니다.<br>조금 더 자세한 상황은 아래와 같습니다.</p><ul><li>구성원 정보를 잘 관리하고 싶은 대규모 조직</li><li>여러 솔루션이나 시스템 별 ID/PW를 자꾸 까먹는 사람</li><li>구성원의 변화가 잦은 조직</li></ul><p>우리의 고객들은 이런 디렉터리 서비스를 이용한 IdP(Identity Provider)를 운영하고 있을것이고, 우리는 고객의 IdP를 이용해서 Single sign-on을 가능하게 해주면 됩니다!</p><h3>Shallow dive</h3><p>LDAP가 대충 뭐고, 왜 생겼는지 알았으니 구현을 위해 필요한 정보를 조금만 더 알아보겠습니다.</p><h4>LDAPv3</h4><p>여러 규약들이 그렇듯이 LDAP도 major 버전이 몇개 있는데, 최근에 많이 사용하는 v3를 대부분 지원하거나 사용한다고 하니 우리도 v3만 지원해도 큰 문제가 될것같진 않습니다.</p><p><em>우리가 사용할 LDAP v3는 </em><a href="https://tools.ietf.org/html/rfc2251"><em>RFC2251</em></a><em>에 정의되어 있습니다.</em></p><h4>LDAP 클라이언트</h4><p>LDAP 서버가 있다면 당연히 LDAP 서버에 접근하는 클라이언트가 있을거고, 실제로 클라이언트는 누가 될까요?</p><p>이큐브랩 구성원 정보가 담긴 LDAP 서버가 있다고 가정을 하겠습니다.<br>그러면 LDAP 서버의 클라이언트는 ERP 서버가 될수도 있겠죠.</p><p>LDAP 서버에 있는 사용자 정보로(만) 자격 증명이 가능해지니 LDAP 서버에 등록된 사용자(만) ERP 서버에 로그인을 할수 있게 되는것입니다.</p><h4>LDAP는 바이너리 프로토콜</h4><p>LDAP는 메세지 내용을 ASN.1(Abstract Syntax Notation One)이라는 언어로 표현하고, 이 메세지를 BER(Basic Encoding Rules) 라는 포맷으로 인코딩해서 메세지를 주고받는다고 하는데요,<br>이 BER 인코딩의 결과가 바이너리라서 이 내용을 사람이 보고 읽을수 있는 텍스트는 아닙니다.</p><p>여기서 중요한건 LDAP는 “사람이 읽을수 없는 형태”로 데이터를 주고 받는다는 사실입니다. (<a href="https://stackoverflow.com/questions/2645009/binary-protocols-v-text-protocols">binary vs text</a>)</p><p>우리는 용도에 따라 적합하게 설계된 프로토콜 위에서 데이터를 주고받으면 그만이니까요 😁</p><h4>ASN.1 &amp; BER의 비교 (<a href="http://luca.ntop.org/Teaching/Appunti/asn1.html">spec 참고</a>)</h4><p>위에서 언급한 이 두가지 요소가 어떻게 다른지 조금 알아보겠습니다.</p><p><strong>ASN.1</strong>은 프로그래밍 언어와 비슷한 반면, <strong>BER</strong>은 해당 언어의 컴파일러와 비슷합니다.<br>컴파일러의 결과물은 플랫폼마다 다를수 있지만 대부분의 high level 프로그래밍 언어는 플랫폼에 종속적이지 않습니다.</p><p>프로그래밍 언어인 C언어로 비유하자면, C로 작성한 코드는 C언어가 아니며 그저 C로 작성된것입니다.<br>그리고 C로 작성된 코드는 특정 플랫폼(ex. Intel x86, …)에서 실행하려면 플랫폼에 맞는 프로그램으로 컴파일되어야만 합니다.</p><p><strong>ASN.1</strong>과 <strong>BER</strong>의 관계 또한 이것과 비슷합니다.</p><ul><li>C → ASN.1</li><li>C로 작성한 코드 → ASN.1로 표현한 표준</li><li>컴파일러 → BER</li><li>프로그램 → BER 인코딩 결과</li></ul><p>이것을 적용하여 다시 설명해보겠습니다.</p><p>ASN.1(C)은 표준(코드)을 작성하는 언어입니다. 그리고 여기서 말하는 작성된 표준(작성된 코드)은 ASN.1(C)이 아니지만 ASN.1(C)으로 작성된것이죠.<br>ASN.1(C)으로 작성한 표준(코드)을 어떤 의미로 보면 “ASN.1 데이터(C 파일이나 코드조각)” 라고 볼수도 있습니다.<br><em>(그러나 이제 우리는 엄밀히 따지면 “ASN.1 데이터” 와 “ASN.1”는 다르다고 이야기 할 수 있게 되었죠.)</em></p><p>그러나 이렇게 작성된 “ASN.1 데이터(C 파일이나 코드조각)”를 LAN으로 전송하려면(실행하려면) Octet string같은걸로 인코딩(컴파일)해야 합니다. (<a href="https://www.manty.co.kr/bbs/detail/develop?id=138">정확히는 BER Values 참고</a>)<br>이것을 BER(컴파일러)으로 인코딩(컴파일)하여 LAN을 통해 클라이언트에게 전달합니다.</p><p>두가지 개념의 설명을 돕기 위해 비유를 해봤는데, 이해하는데 도움이 되었길 바랍니다 🙏</p><p>또한 LDAP에서의 ASN.1, BER의 자세한 동작 원리를 설명한 글들은 많은듯 하니 LDAP 서버를 구현하기 위한 개념 설명은 여기까지만 하겠습니다.</p><h4>LDAP는 비동기 프로토콜</h4><p>HTTP는 기본적으로 동기 프로토콜이라 하나의 요청을 보내면 해당 커넥션은 응답을 받을때까지 다른 동작을 하지 않고 기다립니다.</p><p>그러나 LDAP는 하나의 커넥션에서 여러 메세지를 주고 받을수 있고, 각 메세지에 대한 응답도 타이밍이 제각각일수 있습니다.<br>이런 특성을 가지니 당연히 메세지마다 ID가 존재해서 어떤 요청에 대한 응답인지 알수 있겠죠.</p><p><a href="https://jmoon417.tistory.com/27">참고 1</a>, <a href="https://en.wikipedia.org/wiki/Asynchronous_communication">참고 2</a>를 보면 동기 프로토콜과의 제일 큰 차이점은 클락의 동기화가 필요 없다는 부분인데, LDAP 서버를 구현해보지 않았기 때문인지… 찾아봐도 당장은 어떤 특성을 위해 비동기 프로토콜로 설계 했는지는 모르겠네요.<br>어쩌면 굳이 동기 프로토콜을 사용할 필요가 없기 때문 일수도 있겠지만 당장 큰 문제는 없기 때문에 다음에 찾아봐야겠습니다.</p><h4>LDAP의 디렉터리 구조</h4><p>구성 요소를 알아보기 전에 어떻게 저장을 하는지 구경해보고 가겠습니다.</p><p>엔트리는 계층적 트리 구조로, 아래와 같이 구성됩니다.</p><pre>dc:         com<br>             |<br>          ecubelabs    <br>          /      \<br>ou:   People   servers<br>      /    \     ..<br>cn: ..  Tim.Kang</pre><p>또한 신뢰성이나 가용성을 개선하기 위해 쉽게 복제할수 있는 아키텍쳐로 이루어져 있다고 합니다.</p><h3>LDAP의 구성요소</h3><p>이정도로 LDAP를 구현하기 위한 내용을 알았으면 슬슬 LDAP를 구현할 수 있어야겠죠.<br>그러려면 LDAP가 어떤 요소로 이루어졌는지 알아야합니다.</p><p><a href="https://ldap.com/basic-ldap-concepts/">LDAP.com에서 말하는 기본 컨셉</a>은 이렇습니다.</p><h4>Entry</h4><p>LDAP 서버는 n개의 엔트리가 Tree 구조로 들어있습니다.</p><p>각 엔트리는 DN라 칭해지는 고유 ID와 n개의 속성이 들어있는데, 각 특성은 아래와 같습니다.</p><ul><li><strong>DN</strong>: 이 값을 통해 어디에 속한 엔트리인지 알 수 있습니다.</li><li><strong>Attribute (속성)</strong>: 각 속성은 n개 이상 존재할 수 있으며 Dictionary의 Key/value처럼 이름, 값을 가지고 있습니다.</li></ul><p>더 자세한 설명은 아래를 참고하세요.</p><h4>DN (Distinguished name, 고유명), RDN (Relative DN)</h4><p>데이터베이스의 PK와 비슷하며, 해당 항목과 복잡한 트리 구조인 DIT(Directory Information Tree) 계층 구조에서 해당 항목과 항목의 위치를 고유하게 식별하기 위해 존재합니다.<br>그리고 LDAP에서의 DN은 파일 시스템의 파일 경로와 매우 유사합니다.</p><pre>/users/tim/friends.md</pre><p>이러한 경로 전체가 DN이라고 볼 수 있고, 여기서 “/users/tim”이 상위 엔트리의 DN이라고 보면 됩니다.</p><p>또한 LDAP의 DN은 RDN을 0개 이상 가질수 있습니다.<br>각 RDN은 1개 이상의 속성을 가지고 있습니다.</p><p>예를 들어 “uid=tim.kang”는 “uid”라는 속성에 “tim.kang”라는 값을 가진 RDN을 뜻합니다.<br>당연히 여러개의 속성을 가질수도 있는데, 더 자세한 예시는 <a href="https://ldap.com/basic-ldap-concepts/">컨셉 페이지</a>를 참고하세요.</p><h4>Attributes</h4><p>속성은 특정 항목에 대한 데이터를 보유합니다.<br>각 속성은 속성 유형과 0개 이상의 실제 데이터 값이 있습니다.</p><p>이 실제 데이터에는 Attribute option(속성 옵션)도 포함되는데,<br>이 부분은 자세히 짚고 넘어가지 않을 예정이라 <a href="https://ldap.com/understanding-ldap-schema/">LDAP 스키마 문서</a>와 <a href="https://ldap.com/attribute-syntaxes/">속성 문법 문서</a>를 참고하세요.</p><h4>Object Classes</h4><p>객체 클래스는 특정 유형의 객체나 프로세스, 엔티티 등과 관련 될 수있는 속성 유형의 Collection을 지정하는 스키마 요소입니다.<br>모든 항목에는 도메인 모델처럼 객체 종류를 나타내는 객체 클래스가 있으며, 0개 이상의 보조 객체가 있을수도 있습니다.</p><p>속성 유형과 마찬가지로 객체 클래스에는 객체 식별자(OID)가 존재해야 하지만 이름이 0개일수도 있다고 합니다.<br>객체 클래스에는 필요한 속성 유형 Sets이 필요하다고 하는데, optional 하게 선택될 수 있는 유형 sets도 존재한다고 합니다.</p><h4><a href="https://ldap.com/object-identifiers/">Object Identifiers</a> (OIDs, 객체 식별자)</h4><p>OID는 문서에서 설명하고 있는대로 LDAP 프로토콜 뿐만 아니라 다른 컴퓨팅 영역에서도 다양한 요소를 고유하게 식별하는 용도로 사용되는 문자열입니다.<br>또한 OID는 마침표로 구분 된 숫자로 구성되는데, “1.2.840.113556.1.4.473”같은 형태로 구성됩니다. (자세한 스펙은 <a href="https://tools.ietf.org/html/rfc4512">RFC4512 참고</a>)</p><p>LDAP에서는 OID가 아래같은 용도를 위해 사용된다고 합니다. (<a href="https://tools.ietf.org/html/rfc4520">RFC4520</a>에도 이렇게 정의되어 있습니다.)</p><ul><li>LDAP 요청 및 응답 제어의 식별자 역할</li><li>LDAP extended 요청 및 응답 유형의 식별자 역할</li><li>객체 클래스같은 스키마 요소에 대한 식별자 역할</li></ul><p>만약 OID를 만들고싶다면 <a href="https://pen.iana.org/pen/PenApplication.page">https://pen.iana.org/pen/PenApplication.page</a> 에서 양식을 작성하여 제출하고 기업에 대한 OID를 할당받아야 합니다.<br>Base OID를 받고나면 규칙에 따라 OID를 할당해서 사용하면 됩니다. (규칙은 <a href="https://ldap.com/object-identifiers/">OID 문서 참고</a>)<br>기업에 할당된 모든 OID 목록을 보려면 <a href="https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers">https://www.iana.org/assignments/enterprise-numbers/enterprise-numbers</a> 를 확인하면 됩니다.</p><p>OID를 제대로 할당받지 않고 가짜 OID를 사용할수도 있지만, 테스트를 하는 경우를 제외하더라도 사용하는 시스템에 따라 형식이 맞지 않는 OID를 지원하지 않는 경우가 있으니 권장하지 않는다고 합니다.</p><p>그러나, 우리가 일반적으로 사용하는 OID는 이미 <a href="https://ldap.com/ldap-oid-reference-guide/">LDAP OID Reference guide</a>에 잘 정리되어 있으며, 검색을 하고싶으면 <a href="http://www.oid-info.com/">OID Repository</a> 또는 OID Reference 사이트에서 찾을 수 있습니다 🥰 (<a href="http://oid-info.com/get/0.9.2342.19200300.100.1.3">검색 예시</a>)</p><h3>LDAP CLI</h3><p>LDAP 서버를 구축해도 테스트를 하려면 ldap cli를 사용하거나 다른 클라이언트 프로그램을 사용해야 합니다.</p><p>다행히 macOS인 경우 기본적으로 ldap cli가 설치되어 있습니다.<br>명령어는 <a href="https://docs.oracle.com/cd/B10501_01/network.920/a96579/comtools.htm">Oracle LDAP CLI Commands</a> 페이지를 보면 간단히 따라할 수 있습니다.</p><p>예를 들어, Search 요청은 아래처럼 할 수 있습니다.</p><pre>$ ldapsearch -h &lt;ldap server host&gt; -p 636 -s sub -D &quot;cn=&lt;Your RootDN&gt;&quot; -w &lt;Your Password&gt; -b &quot;ou=people, dc=ecubelabs, dc=com&quot; &quot;objectclass=*&quot;</pre><pre># extended LDIF<br>#<br># LDAPv3<br># base &lt;ou=people,dc=ecubelabs,dc=com&gt; with scope subtree<br># filter: objectclass=*<br># requesting: ALL<br>#</pre><pre># people, ecubelabs.com<br>dn: ou=people, dc=ecubelabs, dc=com<br>description: All people in organization<br>objectclass: organizationalunit<br>ou: people</pre><pre># tim, people, ecubelabs.com<br>dn: cn=tim, ou=people, dc=ecubelabs, dc=com<br>cn: tim<br>...<br>userpassword: ...</pre><p>그리고 이것은 아래에서 다루는 명령어를 직접 써보기 위해 사용해볼 예정입니다.</p><h3><a href="https://en.wikipedia.org/wiki/LDAP_Data_Interchange_Format">LDIF</a></h3><p>LDAP CLI를 사용해서 디렉터리 서버에 있는 데이터를 조작하려면 LDIF라는 표현 형식을 알아둬야 합니다.</p><p>LDAP는 바이너리 프로토콜이라 테스트를 하려면 사람이 직접 표현하고 쓰기가 어렵습니다.<br>그래서 이걸 해결하기 위해 LDIF가 생겼는데, <a href="https://docs.aws.amazon.com/ko_kr/directoryservice/latest/admin-guide/create.html">AWS의 디렉터리 서비스 문서</a>에는 아래와 같이 설명하고 있습니다.</p><blockquote>LDIF 파일은 LDAP(Lightweight Directory Access Protocol) 디렉터리 콘텐츠 및 업데이트 요청을 표현하기 위한 표준 일반 텍스트 데이터 교환 형식입니다. LDIF는 레코드 세트(객체 또는 엔트리당 한 개의 레코드)로서 디렉터리 콘텐츠를 전달합니다. 또한 추가, 수정, 삭제, 이름 바꾸기와 같은 업데이트 요청들을 레코드 세트(업데이트 요청당 한 개의 레코드)로서 표현합니다.</blockquote><p>LDIF를 구성하는 필드는 일반적으로 아래와 같습니다.</p><h4>DN</h4><p>위에서 언급했던 그 DN(Distinguished name)과 똑같다고 생각하면 됩니다.<br>하나의 엔트리를 표현한 LDIF에서는 1개의 DN 필드가 존재합니다.</p><h4>DC</h4><p>말 그대로 도메인의 구성요소(Domain component)를 뜻하는 필드인데, DN으로 표현하면 보통 아래와 같이 구성합니다.</p><pre>dc=ecubelabs,dc=com</pre><p>특별한 경우가 없다면 대부분의 디렉토리 서비스에서는 이런식의 DC를 사용할것으로 생각됩니다.</p><h4>OU</h4><p>Organizational unit의 약자입니다.<br>조직을 구성하는 개체들의 묶음으로 나눠서 관리하는게 일반적인것으로 보입니다.<br>그리고 일반적으로 DC의 하위에 위치하도록 관리합니다.</p><p>“people”이라는 OU가 있다고 가정하고 DN으로 표현하면 아래와 같이 구성됩니다.</p><pre>ou=people,dc=ecubelabs,dc=com</pre><h4>CN</h4><p>Common name의 약자입니다.</p><p>보통은 LDAP 서버에 쿼리해서 가져오는 객체는 이 CN이 아닐까 싶습니다.<br>위키에서는 CN을 이렇게 설명하고 있습니다.</p><blockquote>이것은 귀하가 쿼리하고 있는 개별 개체 (개인 이름, 회의실, 레시피 이름, 직책 등)를 나타냅니다.</blockquote><p>이것 또한 DN으로 표현하면 아래와 같습니다.</p><pre>cn=tim,ou=people,dc=ecubelabs,dc=com</pre><h4>DN의 표현?</h4><p>앞서 각 필드를 DN으로 표현할 수 있다고 했습니다.<br>그리고 DN은 데이터베이스의 PK와 비슷하다고 했죠.<br>게다가 파일 시스템의 파일 경로와도 비슷하게 표현된다고 했습니다.</p><p>다시 한번 비교하면서 살펴보겠습니다.</p><pre>/company/ecubelabs/people/tim.md</pre><p>위와 같은 경로에 tim.md이라는 파일이 있고, 그 안에 여러 정보들이 들어있다고 생각해보겠습니다.</p><p>그럼 이걸 LDIF로 표현하면 아래와 같습니다.</p><pre>dn: cn=tim, ou=people, dc=ecubelabs, dc=com<br>objectClass: localperson<br>...<br>cn: tim<br>ou: SW<br>...<br>userpassword: ...</pre><p>DN만 보면 “cn=tim, ou=people, dc=ecubelabs, dc=com” 이라는 값으로 정의되는데, 경로를 역순으로 표현했다고 받아들여도 무방해보입니다.</p><h4>LDIF -&gt; “people” OU</h4><p>아래는 people이라는 OU를 표현한 예시입니다.</p><pre>dn: ou=people, o=ecubelabs<br>ou: people<br>description: All people in organisation<br>objectclass: organizationalunit</pre><h3>LDAP Operations</h3><p><a href="https://ldap.com/ldap-operation-types/">LDAP Operation Types</a> 문서를 보면 10개의 명령어가 있는것을 알 수 있는데요, 여기서는 기본적인 커맨드에 대해서만 짚어보고 넘어가겠습니다. 😄</p><h4><a href="https://ldap.com/the-ldap-bind-operation/">Bind</a></h4><p>LDAP의 Bind 요청은 SASL 인증을 포함한 단순 자격증명(like id/pw)으로 인증하는 기능을 제공합니다.<br>클라이언트가 서버에 다른 유형의 요청을 하려면 해당 커넥션에서 Bind를 요청한 뒤에 사용해야 합니다. 이것은 다른 유형의 요청을 하기 전에 Bind를 수행할 필요가 없다는 이야기와 같습니다.</p><p>기본적으로 Bind 요청은 3가지의 동작이 포함됩니다.</p><ul><li><strong>클라이언트가 사용 할 LDAP 프로토콜 버전을 서버가 알 수 있도록 명시합니다.</strong><br>이 값은 정수여야 하며, 최신 앱은 항상 3을 사용하도록 해야합니다.</li><li><strong>인증 할 사용자의 DN을 명시합니다.</strong><br>익명 인증인 경우 비워둘 수 있지만 보통은 입력해야 합니다.</li><li><strong>클라이언트가 인증할 자격 증명 정보를 명시합니다.</strong><br>단순 자격증명인 경우 앞서 DN에 명시한 사용자의 패스워드를 입력합니다.</li></ul><h4><a href="https://ldap.com/the-ldap-add-operation/">Add</a></h4><p>Add 요청을 하면 LDAP 서버의 계층적 트리 구조에 새 엔트리를 추가할 수 있습니다.</p><p>Add 요청을 하기 위해서는 DN과 해당 항목에 포함시킬 속성을 같이 넣어야 합니다.<br>우리는 테스트 할 때 위에서 말했던 LDIF 형식을 사용해야 합니다.</p><p>아래와 같은 파일이 있다고 가정합니다.</p><pre><strong># people.ldif</strong><br>dn: ou=people, dc=ecubelabs, dc=com<br>ou: people<br>description: All people in organisation<br>objectclass: organizationalunit</pre><p>그리고 터미널에서 아래와 같이 요청을 할 수 있습니다.</p><pre>$ ldapadd -h &lt;ldap server host&gt; -p 636 -D &quot;cn=&lt;Your RootDN&gt;&quot; -w &lt;Your Password&gt; -f ./people.ldif</pre><pre>adding new entry &quot;ou=people, dc=ecubelabs, dc=com&quot;</pre><h4>Search</h4><p>Search 요청은 LDAP 서버가 가지고 있는 데이터를 쿼리해서 가져올수 있게 해줍니다.</p><p>위에서 처음 들었던 예시가 바로 이것인데요, CLI를 사용하면 아래처럼 됩니다.</p><pre>$ ldapsearch -h &lt;ldap server host&gt; -p 636 -s sub -D &quot;cn=&lt;Your RootDN&gt;&quot; -w &lt;Your Password&gt; -b &quot;ou=people, dc=ecubelabs, dc=com&quot; &quot;objectclass=*&quot;</pre><pre># extended LDIF<br>#<br># LDAPv3<br># base &lt;ou=people,dc=ecubelabs,dc=com&gt; with scope subtree<br># filter: objectclass=*<br># requesting: ALL<br>#</pre><pre># people, ecubelabs.com<br>dn: ou=people, dc=ecubelabs, dc=com<br>description: All people in organization<br>objectclass: organizationalunit<br>ou: people</pre><pre># tim, people, ecubelabs.com<br>dn: cn=tim, ou=people, dc=ecubelabs, dc=com<br>cn: tim<br>...<br>username: tim<br>userpassword: ...</pre><p>“-s” 플래그의 옵션으로 “base”, “one”, “sub”라는 값이 존재하는데, 이 값들은 검색을 어떤 영역까지 할지에 대한 옵션입니다.<br>이 외에도 다양한 기능이 존재하니 <a href="https://ldap.com/the-ldap-search-operation/">LDAP Search Operation</a> 페이지를 참고하세요 🙂</p><h3>정리</h3><p>LDAP를 이해하고 구현하기 위해 필요한 개념만 알아봤습니다.<br>서버를 구현하거나, LDAP 서버를 이용하면서 필요한 기본적인 내용을 찾아놓았다고 생각하는데 부족한게 있다면 연락 남겨주세요 🙂</p><h3>References</h3><ul><li><a href="https://medium.com/happyprogrammer-in-jeju/ldap-%ED%94%84%ED%86%A0%ED%86%A0%EC%BD%9C-%EB%A7%9B%EB%B3%B4%EA%B8%B0-15b53c6a6f26">https://medium.com/happyprogrammer-in-jeju/ldap-%ED%94%84%ED%86%A0%ED%86%A0%EC%BD%9C-%EB%A7%9B%EB%B3%B4%EA%B8%B0-15b53c6a6f26</a></li><li><a href="https://m.etnews.com/199605110042?SNS=00004">https://m.etnews.com/199605110042?SNS=00004</a></li><li><a href="https://en.wikipedia.org/wiki/X.500">https://en.wikipedia.org/wiki/X.500</a></li><li><a href="https://ts.devbj.com/29">https://ts.devbj.com/29</a></li><li><a href="https://www.manty.co.kr/bbs/detail/develop?id=138">https://www.manty.co.kr/bbs/detail/develop?id=138</a></li><li><a href="https://ldap.com/basic-ldap-concepts/">https://ldap.com/basic-ldap-concepts/</a></li><li><a href="https://tools.ietf.org/html/rfc2251">https://tools.ietf.org/html/rfc2251</a></li><li><a href="https://tools.ietf.org/html/rfc4512">https://tools.ietf.org/html/rfc4512</a></li><li><a href="https://tools.ietf.org/html/rfc4517">https://tools.ietf.org/html/rfc4517</a></li></ul><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=4e5aecd358e3" width="1" height="1" alt=""><hr><p><a href="https://medium.com/ecube-labs/ldap%EC%97%90-%EB%8C%80%ED%95%B4-%EC%95%8C%EC%95%84%EB%B3%B4%EC%9E%90-4e5aecd358e3">LDAP에 대해 알아보자</a> was originally published in <a href="https://medium.com/ecube-labs">Ecube Labs</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
    </channel>
</rss>