runbooks 0.2.3__py3-none-any.whl → 0.6.1__py3-none-any.whl

runbooks/security_baseline/report_template_kr.html

@@ -24,19 +24,19 @@
             </path>
         </symbol>
         <symbol id="bi-x-circle-fill" fill="currentColor" viewBox="0 0 16 16">
-            <path 
+            <path
                 d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0zM5.354 4.646a.5.5 0 1 0-.708.708L7.293 8l-2.647 2.646a.5.5 0 0 0 .708.708L8 8.707l2.646 2.647a.5.5 0 0 0 .708-.708L8.707 8l2.647-2.646a.5.5 0 0 0-.708-.708L8 7.293 5.354 4.646z">
             </path>
         </symbol>
         <symbol id="bi-dash-circle" fill="currentColor" viewBox="0 0 16 16">
-            <path 
+            <path
                 d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z">
             </path>
-            <path 
+            <path
                 d="M4 8a.5.5 0 0 1 .5-.5h7a.5.5 0 0 1 0 1h-7A.5.5 0 0 1 4 8z">
             </path>
         </symbol>
-    </svg> 
+    </svg>
 
     <div class="container">
     <div class="row justify-content-center">
@@ -49,7 +49,7 @@
                 <div class="col-6">
                     <table class="table">
                         <tr>
-                            <td>Account</td><td>{{ account_id }}</td>
+                            <td>AWS Account</td><td>{{ account_id }}</td>
                         </tr>
                         <tr>
                             <td>Generated at</td><td>{{ generated_at }}</td>
@@ -88,15 +88,15 @@
                 {% for section in result_sections %}
                 <div class="card-body" id="{{ section.level|lower }}-list">
                 <div class="accordion" id="accordionSection{{ section.level }}">
-                    
+
                     {% for item in section.result_items %}
                     <div class="accordion-item">
                     <h2 class="accordion-header" id="panelsStayOpen-heading-{{ section.level|lower }}-{{ '%02d'|format(loop.index) }}">
                         <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapse-{{ section.level|lower }}-{{ '%02d'|format(loop.index)}}" aria-expanded="true" aria-controls="panelsStayOpen-collapse-{{ section.level|lower }}-{{ '%02d'|format(loop.index)}}">
                             <span class="badge text-bg-{% if section.level == 'Error' %}dark{% elif section.level == 'Info' %}primary{% else %}{{ section.level|lower }}{% endif %} rounded-pill">{{ section.level }}</span>
-                            <div class="ms-2 me-auto">{{ item.title }}</div>                            
+                            <div class="ms-2 me-auto">{{ item.title }}</div>
                         </button>
-                    </h2>        
+                    </h2>
                     <div id="panelsStayOpen-collapse-{{ section.level|lower }}-{{ '%02d'|format(loop.index)}}" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-heading-{{ section.level|lower }}-{{ '%02d'|format(loop.index) }}">
                         <div class="accordion-body">
                             <div class="alert alert-{% if section.level == 'Error' %}dark{% elif section.level == 'Info' %}primary{% else %}{{ section.level|lower }}{% endif %} d-flex align-items-center" role="alert">
@@ -141,7 +141,7 @@
         <div class="col-10 col-lg-8">
 
             <!-- Below this section, you can add content references for each language. -->
-             
+
             <br>
             <div class="row">
                 <div class="alert alert-primary d-flex align-items-center" role="alert">
@@ -156,7 +156,7 @@
                     </span>
                 </div>
             </div>
-            
+
             <div class="row">
                 <div class="alert alert-primary d-flex align-items-center" role="alert">
                     <svg aria-label="Info:" class="bi flex-shrink-0 me-2" width="24" height="24" role="img">
@@ -169,21 +169,21 @@
                     </span>
                 </div>
             </div>
-            
+
             <div class="row">
                 <div class="alert alert-primary d-flex align-items-center" role="alert">
                     <svg aria-label="Info:" class="bi flex-shrink-0 me-2" width="24" height="24" role="img">
                         <use xlink:href="#info-fill"></use>
                     </svg>
                     <span>
-                        AWS Trusted Advisor 사용 방법에 대한 자세한 내용은 
+                        AWS Trusted Advisor 사용 방법에 대한 자세한 내용은
                         <a href="https://aws.amazon.com/ko/premiumsupport/knowledge-center/trusted-advisor-intro/" target="_blank" style="overflow:hidden;word-break:break-all;">
                             여기
                         </a>를 눌러 확인해주세요.
                     </span>
                 </div>
             </div>
-            
+
             <div class="col"></div>
         </div>
         </div>

runbooks/security_baseline/report_template_vn.html

@@ -24,19 +24,19 @@
             </path>
         </symbol>
         <symbol id="bi-x-circle-fill" fill="currentColor" viewBox="0 0 16 16">
-            <path 
+            <path
                 d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0zM5.354 4.646a.5.5 0 1 0-.708.708L7.293 8l-2.647 2.646a.5.5 0 0 0 .708.708L8 8.707l2.646 2.647a.5.5 0 0 0 .708-.708L8.707 8l2.647-2.646a.5.5 0 0 0-.708-.708L8 7.293 5.354 4.646z">
             </path>
         </symbol>
         <symbol id="bi-dash-circle" fill="currentColor" viewBox="0 0 16 16">
-            <path 
+            <path
                 d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z">
             </path>
-            <path 
+            <path
                 d="M4 8a.5.5 0 0 1 .5-.5h7a.5.5 0 0 1 0 1h-7A.5.5 0 0 1 4 8z">
             </path>
         </symbol>
-    </svg> 
+    </svg>
 
     <div class="container">
     <div class="row justify-content-center">
@@ -49,7 +49,7 @@
                 <div class="col-6">
                     <table class="table">
                         <tr>
-                            <td>Account</td><td>{{ account_id }}</td>
+                            <td>AWS Account</td><td>{{ account_id }}</td>
                         </tr>
                         <tr>
                             <td>Generated at</td><td>{{ generated_at }}</td>
@@ -88,15 +88,15 @@
                 {% for section in result_sections %}
                 <div class="card-body" id="{{ section.level|lower }}-list">
                 <div class="accordion" id="accordionSection{{ section.level }}">
-                    
+
                     {% for item in section.result_items %}
                     <div class="accordion-item">
                     <h2 class="accordion-header" id="panelsStayOpen-heading-{{ section.level|lower }}-{{ '%02d'|format(loop.index) }}">
                         <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#panelsStayOpen-collapse-{{ section.level|lower }}-{{ '%02d'|format(loop.index)}}" aria-expanded="true" aria-controls="panelsStayOpen-collapse-{{ section.level|lower }}-{{ '%02d'|format(loop.index)}}">
                             <span class="badge text-bg-{% if section.level == 'Error' %}dark{% elif section.level == 'Info' %}primary{% else %}{{ section.level|lower }}{% endif %} rounded-pill">{{ section.level }}</span>
-                            <div class="ms-2 me-auto">{{ item.title }}</div>                            
+                            <div class="ms-2 me-auto">{{ item.title }}</div>
                         </button>
-                    </h2>        
+                    </h2>
                     <div id="panelsStayOpen-collapse-{{ section.level|lower }}-{{ '%02d'|format(loop.index)}}" class="accordion-collapse collapse" aria-labelledby="panelsStayOpen-heading-{{ section.level|lower }}-{{ '%02d'|format(loop.index) }}">
                         <div class="accordion-body">
                             <div class="alert alert-{% if section.level == 'Error' %}dark{% elif section.level == 'Info' %}primary{% else %}{{ section.level|lower }}{% endif %} d-flex align-items-center" role="alert">

runbooks/security_baseline/requirements.txt

@@ -0,0 +1,7 @@
+boto3==1.26.70
+botocore==1.29.70
+jmespath==1.0.1
+python-dateutil==2.8.2
+s3transfer==0.6.0
+six==1.16.0
+urllib3==1.26.18

runbooks/security_baseline/run_script.py

@@ -37,7 +37,9 @@ def parse_arguments():
         description="AWS Security Baseline Tester - Evaluate your AWS account's security configuration."
     )
     parser.add_argument(
-        "--profile", default="default", help="AWS IAM profile to use for authentication (default: 'default')."
+        "--profile",
+        default="default",
+        help="AWS IAM profile to use for authentication (default: 'default').",
     )
     parser.add_argument(
         "--language",
@@ -45,7 +47,11 @@ def parse_arguments():
         default="EN",
         help="Language for the Security Baseline Report (default: 'EN').",
     )
-    parser.add_argument("--output", default=None, help="Custom output directory for HTML results (default: ./results).")
+    parser.add_argument(
+        "--output",
+        default=None,
+        help="Custom output directory for HTML results (default: ./results).",
+    )
     return parser.parse_args()
 
 

runbooks/security_baseline/security_baseline_tester.py

@@ -60,7 +60,10 @@ class SecurityBaselineTester:
 
             logging.info(self.translator.translate("test_completed"))
         except Exception as e:
-            logging.error(f"An error occurred during the security baseline test: {str(e)}", exc_info=True)
+            logging.error(
+                f"An error occurred during the security baseline test: {str(e)}",
+                exc_info=True,
+            )
 
     def _validate_session(self):
         if self.session.region_name is None:
@@ -122,7 +125,12 @@ class SecurityBaselineTester:
             "iam_password_policy",
         ]:
             return check_method(self.session, translator)
-        elif check_name in ["root_mfa", "root_usage", "root_access_key", "iam_user_mfa"]:
+        elif check_name in [
+            "root_mfa",
+            "root_usage",
+            "root_access_key",
+            "iam_user_mfa",
+        ]:
             return check_method(self.session, translator, credential_report)
         elif check_name == "trusted_advisor":
             return check_method(translator)

runbooks/security_baseline/utils/common.py

@@ -15,7 +15,11 @@ class Ret:
         self.headers = {"Content-Type": "text/html;charset=UTF-8"}
 
     def to_dict(self) -> dict:
-        return {"statusCode": self.status_code, "body": self.body, "headers": self.headers}
+        return {
+            "statusCode": self.status_code,
+            "body": self.body,
+            "headers": self.headers,
+        }
 
 
 class CheckResult:

runbooks/utils/__init__.py

@@ -0,0 +1,204 @@
+"""
+Utilities package for CloudOps Runbooks.
+
+This package provides utility modules including logging, configuration,
+and helper functions used throughout the runbooks package.
+"""
+
+import sys
+from pathlib import Path
+from typing import Optional
+
+try:
+    from loguru import logger
+
+    _HAS_LOGURU = True
+except ImportError:
+    import logging
+
+    logger = logging.getLogger(__name__)
+    _HAS_LOGURU = False
+
+# Legacy utilities
+from runbooks.utils.logger import configure_logger
+
+
+def setup_logging(debug: bool = False, log_file: Optional[str] = None) -> None:
+    """
+    Configure logging for the application.
+
+    Args:
+        debug: Enable debug logging if True
+        log_file: Optional path to log file
+    """
+    if _HAS_LOGURU:
+        from loguru import logger as loguru_logger
+
+        # Remove default handler
+        loguru_logger.remove()
+
+        # Console handler with appropriate level
+        log_level = "DEBUG" if debug else "INFO"
+        loguru_logger.add(
+            sys.stderr,
+            level=log_level,
+            format="<green>{time:YYYY-MM-DD HH:mm:ss}</green> | <level>{level: <8}</level> | <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>",
+            colorize=True,
+        )
+
+        # File handler if specified
+        if log_file:
+            log_path = Path(log_file)
+            log_path.parent.mkdir(parents=True, exist_ok=True)
+
+            loguru_logger.add(
+                log_path,
+                level="DEBUG",
+                format="{time:YYYY-MM-DD HH:mm:ss} | {level: <8} | {name}:{function}:{line} - {message}",
+                rotation="10 MB",
+                retention="7 days",
+                compression="zip",
+            )
+
+        loguru_logger.info(f"Logging initialized with level: {log_level}")
+    else:
+        # Fallback to standard logging
+        import logging
+
+        log_level = logging.DEBUG if debug else logging.INFO
+        logging.basicConfig(
+            level=log_level,
+            format="%(asctime)s | %(levelname)-8s | %(name)s:%(funcName)s:%(lineno)d - %(message)s",
+            handlers=[logging.StreamHandler(sys.stderr)],
+        )
+
+        if log_file:
+            log_path = Path(log_file)
+            log_path.parent.mkdir(parents=True, exist_ok=True)
+            file_handler = logging.FileHandler(log_path)
+            file_handler.setFormatter(
+                logging.Formatter("%(asctime)s | %(levelname)-8s | %(name)s:%(funcName)s:%(lineno)d - %(message)s")
+            )
+            logging.getLogger().addHandler(file_handler)
+
+        logging.info(f"Logging initialized with level: {log_level}")
+
+
+def validate_aws_profile(profile: str) -> bool:
+    """
+    Validate that an AWS profile exists in credentials.
+
+    Args:
+        profile: AWS profile name to validate
+
+    Returns:
+        True if profile exists, False otherwise
+    """
+    import configparser
+
+    try:
+        # Check ~/.aws/credentials
+        credentials_path = Path.home() / ".aws" / "credentials"
+        if credentials_path.exists():
+            config = configparser.ConfigParser()
+            config.read(credentials_path)
+            if profile in config.sections():
+                return True
+
+        # Check ~/.aws/config
+        config_path = Path.home() / ".aws" / "config"
+        if config_path.exists():
+            config = configparser.ConfigParser()
+            config.read(config_path)
+            profile_section = f"profile {profile}" if profile != "default" else "default"
+            if profile_section in config.sections():
+                return True
+
+        return False
+    except Exception as e:
+        logger.warning(f"Error validating AWS profile '{profile}': {e}")
+        return False
+
+
+def ensure_directory(path: Path) -> Path:
+    """
+    Ensure directory exists, creating it if necessary.
+
+    Args:
+        path: Directory path to ensure
+
+    Returns:
+        The directory path
+    """
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
+def format_size(size_bytes: int) -> str:
+    """
+    Format byte size in human readable format.
+
+    Args:
+        size_bytes: Size in bytes
+
+    Returns:
+        Formatted size string (e.g., "1.5 GB")
+    """
+    if size_bytes == 0:
+        return "0 B"
+
+    size_names = ["B", "KB", "MB", "GB", "TB", "PB"]
+    size_index = 0
+    size = float(size_bytes)
+
+    while size >= 1024 and size_index < len(size_names) - 1:
+        size /= 1024
+        size_index += 1
+
+    return f"{size:.1f} {size_names[size_index]}"
+
+
+def retry_with_backoff(max_retries: int = 3, backoff_factor: float = 1.0):
+    """
+    Decorator for retrying operations with exponential backoff.
+
+    Args:
+        max_retries: Maximum number of retry attempts
+        backoff_factor: Factor for exponential backoff
+    """
+    import time
+    from functools import wraps
+
+    def decorator(func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            last_exception = None
+
+            for attempt in range(max_retries + 1):
+                try:
+                    return func(*args, **kwargs)
+                except Exception as e:
+                    last_exception = e
+                    if attempt == max_retries:
+                        logger.error(f"Failed after {max_retries} retries: {e}")
+                        raise
+
+                    wait_time = backoff_factor * (2**attempt)
+                    logger.warning(f"Attempt {attempt + 1} failed: {e}. Retrying in {wait_time}s...")
+                    time.sleep(wait_time)
+
+            raise last_exception
+
+        return wrapper
+
+    return decorator
+
+
+__all__ = [
+    "setup_logging",
+    "validate_aws_profile",
+    "ensure_directory",
+    "format_size",
+    "retry_with_backoff",
+    "configure_logger",
+]