팀 내 쿡북 공유

팀 내 쿡북 공유하기

한 사람이 코드 품질이나 생산성 향상을 위해 Sensei 레시피를 만들면, 쿡북을 공유하여 팀원 모두가 그 혜택을 누릴 수 있습니다.

Sensei는 쿡북 공유를 위한 다양한 메커니즘을 제공합니다:

• 버전 관리 중인 프로젝트에 쿡북 저장
• 공유 폴더에 쿡북 저장
• Github에 쿡북 저장
• HTTP(s)를 통한 압축 파일 공유

Sensei는 쿡북 공유를 통해 팀의 지식 공유 협업을 돕습니다. 이러한 협업은 의사소통을 개선하고 합의된 코드 품질 접근 방식을 내재화하는 데 기여합니다.

예를 들어, 쿡북을 공유하면 다음과 같은 이점이 있습니다:

• 팀원들이 유용한 레시피를 서로 공유할 수 있습니다.
• 팀 리더가 합의된 코딩 관행을 코드화하여, 주니어 직원이 공통된 위반 사항을 식별하고 즉시 수정할 수 있도록 지원합니다.
• 팀 간 협력을 증진합니다. 예를 들어, 앱 보안(AppSec) 팀이 코드 내 문제를 강조하는 레시피를 만들고, 개발 팀이 빠른 수정안을 작성할 수 있습니다.

다음 섹션에서는 각 공유 메커니즘을 구현하는 방법을 설명합니다.

버전 관리 중인 프로젝트에 쿡북 저장

프로젝트 .sensei 폴더는 쿡북 파일을 생성할 때 기본으로 선택되는 옵션입니다.

• `project://.sensei`

모든 쿡북과 레시피는 프로젝트 내 .sensei 폴더에 저장됩니다.

가장 쉬운 공유 방법은 프로젝트의 .sensei 폴더를 버전 관리에 추가하는 것입니다.

이렇게 하면 .sensei 폴더를 프로젝트와 관련된 다른 공유 코드 아티팩트처럼 관리할 수 있습니다. 쿡북은 YAML 구성 파일로 저장되므로 커밋 및 검토 과정에서 쉽게 병합할 수 있습니다.

이 방식은 공개된 sensei-blog-examples 프로젝트에서 사용하고 있는 방식입니다.

• https://github.com/SecureCodeWarrior/sensei-blog-examples

.sensei 폴더에는 모든 레시피가 포함된 쿡북이 들어 있으며, 저장소를 복제(clone)하는 누구나 이를 사용할 수 있습니다.

쿡북을 원하는 폴더에 저장

팀은 중앙 위치에 저장된 쿡북을 사용할 수도 있습니다.

공유 쓰기 권한이 있는 폴더에 쿡북을 저장하면 팀 전체가 레시피를 업데이트하고, 현재 작업 중인 모든 프로젝트로 가져올 수 있습니다.

위치는 디렉토리 경로로 설정됩니다.

Github에 레시피 저장

Sensei는 Github 저장소에 저장된 레시피에도 액세스할 수 있습니다. 비공개 및 공개 저장소 모두 지원됩니다.

SSH를 통한 Github 연결

SSH 저장소 액세스는 위치(Location)에 대해 다음 구문을 사용하여 구성됩니다.

git@github.com:SecureCodeWarrior/acookbook.git

이 기능이 작동하려면 저장소에 쿡북 폴더의 내용이 포함되어 있어야 합니다.

쿡북을 위한 브랜치와 하위 폴더를 구성할 수도 있습니다. 예: master 브랜치의 cookbook 하위 폴더

예:

• git@github.com:SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

비공개 저장소의 경우 SSH 키를 구성해야 합니다.

• https://github.com/settings/keys

또한 키에는 암호(passphrase)가 없어야 합니다.

HTTPS를 통한 Github 연결

HTTPS를 통해 공개 저장소에 액세스할 수도 있으며, 동일한 repo.git|branch|folder 구문이 사용됩니다. 예:

블로그 예제 프로젝트의 경우:

• https://github.com/SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

기본 보호(Basic Protection) 예제 세트의 경우, 기본적으로 master 브랜치가 선택되고 `rules.sensei` 파일이 루트 폴더에 있으므로 브랜치와 하위 폴더를 생략할 수 있습니다.:

• https://github.com/SecureCodeWarrior/cookbook-basic-protection-set

HTTP(s)를 통한 압축 파일

Sensei는 HTTP 또는 HTTPS를 통해 압축된 쿡북에도 액세스할 수 있습니다.

예: 로컬 8000번 포트에서 HTTP 서버를 실행 중인 경우

• http://localhost:8000/rules.sensei.zip

zip 쿡북 파일에는 rules.sensei 파일과 같은 쿡북 폴더의 내용이 포함되어 있어야 합니다.

공유 요약

Sensei는 여러 쿡북 사용을 지원하므로, 프로그래머 개개인이 자신의 학습과 생산성을 돕는 레시피를 활용할 수 있습니다.

더 중요한 점은 지식이 공유될 때 팀이 가장 효과적으로 일한다는 것입니다. 특정 프로젝트, 특정 라이브러리 또는 공통 마이그레이션 패턴을 위한 팀 공유 저장소를 운영하면 팀 생산성을 높이고 팀의 경험을 체계화하는 데 도움이 됩니다.

쿡북을 공유하면 여러 팀이 동일한 쿡북을 사용할 수 있어 AppSec에서 개발팀에 이르기까지 서로 다른 분야 간의 협업을 개선할 수 있습니다.

Sensei는 네 가지 핵심 공유 메커니즘을 제공하므로, 지식 공유를 위한 협업을 강화할 수 있는 방법을 최소 하나 이상 찾으실 수 있을 것입니다.

---

IntelliJ의 "Preferences \ Plugins"(Mac) 또는 "Settings \ Plugins"(Windows)에서 "sensei secure code"를 검색하여 Sensei를 설치할 수 있습니다.

모든 Sensei 블로그 게시물 코드와 레시피는 다음 Github 저장소에서 확인할 수 있습니다:

• https://github.com/SecureCodeWarrior/sensei-blog-examples