Project

General

Profile

Feature #1257

Updated by 성용 양 13 days ago

## 목적 

 학생 조회, 개인정보 복호화, 성적 정정, 납부 변경, 증명서 발급, Excel 내보내기를 누가 언제 했는지 추적합니다. (NFR-OPS-003, FR-OPS-001) 

 ## 쉬운 설명 

 누가 언제 어떤 중요 정보를 보거나 바꿨는지 기록하는 감사 로그입니다. 다른 앱은 record() 호출만 추가합니다. 

 ## 기술 스택 

 Django 모델·시그널·서비스 함수, 추가 전용(append-only) 로그, 해시 체인(후보), 로그 평문 개인정보 마스킹. 

 ## 예상 결과(산출물) 

 AuditLog 모델, 기록 서비스 함수 `audit.record(...)`, 이벤트 종류 규약, 조회 화면, 테스트. 

 ## 개발 작업 상세 

 1. AuditLog 필드를 정한다: 행위자, 시각, 대상 종류·ID, 행위, 전후값(개인정보는 마스킹). 
 2. 수정·삭제를 막는 추가 전용 규칙과 위변조 탐지(해시 체인 후보)를 구현한다. 
 3. 이벤트 규약(예: `grade.correct`, `pii.decrypt`)을 정해 다른 앱이 호출만 하게 한다. 
 4. 관리자용 로그 조회 화면(검색·필터)을 만든다. 
 5. 테스트: 로그 수정 시도 차단, 개인정보 평문 미기록. 

 ## 완료 기준 

 - 성적 정정·학적 변경·납부 수정이 감사 이력으로 추적된다(인수 테스트 6). 

 ## 충돌 방지(소유 범위) 

 security/ 앱 소유. 다른 앱은 record() 호출만 추가합니다. 

 ## 선행·후행·위험 

 선행: 02-04 역할·권한(RBAC) 구현(김예주, 11/24 종료) 

 후행: 02-06 보안 점검·자동 테스트 모음 정리(김예주) / 03-02 계정 승인·비활성화·직원 계정 관리 화면(서현) / 06-01 지원자 모델·지원 상태·입학 판정(김예주) / 07-02 학적 상태·변동 이력(적용일·사유·처리자·전후값)(우섭) / 08-04 성적 정정 이력·재수강·대체/인정 학점(성용) / 09-02 장학금·감면·환불·분할 납부·처리 이력(서현) / 11-03 성적증명서·졸업·학위 관련 문서·발급 기록(서현) / 12-02 Excel 가져오기·내보내기(오류 행 검증)(김예주) 

 ## 결과 확인 방법 

 "완료 기준"의 각 항목을 화면 또는 명령으로 직접 확인합니다. 

 1. 성적 정정·학적 변경·납부 수정이 감사 이력으로 추적된다(인수 테스트 6). 
 2. pytest가 모두 통과한다. 
 3. 확인 결과(화면 캡처 또는 명령 출력 요약)를 일감 메모에 남긴다. 


 ## 갱신 사항 (2026-11-04) 

 - ERD 검수 반영: AuditLog에 prev_hash/hash(해시 체인 채택 시), 마스킹된 change_summary, request_id 추가를 검토한다. 파일 다운로드와 개인정보 복호화도 이 로그의 이벤트(file.download, pii.decrypt)로 기록한다. 

 ## 시작 전 준비 

 1. 선행 일감의 결과물(문서·코드)을 먼저 읽고 약속된 이름·구조를 확인한다. 
 2. 저장소를 최신으로 맞춘다: git switch main 후 git pull --ff-only origin main 
 3. 저장소 README 8번과 팀 로컬 세팅 안내 README(01-01 결과) 순서대로 환경을 준비한다. 보통 py -3.12 python -m venv .venv, 가상환경 켜기, python -m pip install -r requirements-dev.txt, Windows에 설치한 PostgreSQL 18에서 개인 로컬 DB(university_dev) 생성, .env.local 설정(DB_NAME, DB_USER, DB_PASSWORD, DB_HOST, DB_PORT), requirements.txt, docker compose up -d db(DB 실행), python manage.py check, python manage.py migrate 순서이다. 최초 실행에 makemigrations는 필요 없고, .env.local과 비밀번호는 공유·커밋하지 않는다. 
 4. #1226의 폴더 소유 표에서 내가 고칠 수 있는 폴더를 확인한다. 

 ## 작업 진행 순서 

 1. 브랜치를 만든다: git switch -c feature/MDGU-번호-짧은이름 
 2. "개발 작업 상세"의 번호 순서대로 한 단계씩 구현하고, 단계마다 pytest로 확인한다. 
 3. 모델을 바꾸면 python manage.py makemigrations, 그다음 python manage.py migrate를 실행한다. 
 4. 화면은 python manage.py runserver로 실행해 직접 열어 보고 "완료 기준"과 하나씩 대조한다. 
 5. git add, git commit, git push 후 PR을 만든다. PR 템플릿의 체크리스트를 채우고 폴더 소유자의 리뷰를 받는다. 
 6. 병합 후 이 일감 메모에 PR 링크와 확인 결과를 적고 상태와 진행률을 갱신한다. 

 ## 막힐 때 확인 

 로그에 개인정보 원문을 넣지 마세요. 대상 식별자(ID)만 기록합니다. 

 그래도 해결되지 않으면 일감 메모에 "무엇을 했고, 어떤 오류가 났는지"를 붙여 담당 분류 소유자 또는 팀장에게 질문하세요. 

 ## 용어 풀이 

 - **감사 로그**: 누가 언제 무엇을 했는지 남기는 변경 불가 기록입니다. 문제가 생겼을 때 추적하는 근거가 됩니다. 
 - **openpyxl**: Python에서 Excel(.xlsx) 파일을 읽고 쓰는 라이브러리입니다. 
 - **서비스 함수**: 다른 앱이 직접 DB를 건드리지 않고 이 함수를 통해서만 기능을 쓰게 만든 창구입니다.

Back