Skip to content

Security: kaiiiichen/SudoSodoku

Security

.github/SECURITY.md

Security Policy

Supported Versions

We actively support security updates for the following versions:

Version Supported
1.0.x βœ…
< 1.0 ❌

Reporting a Vulnerability

We take security vulnerabilities seriously. If you discover a security vulnerability, please follow these steps:

πŸ”’ How to Report

Please do NOT report security vulnerabilities through public GitHub issues.

Instead, please report them via one of the following methods:

  1. GitHub Security Advisory: Use GitHub's private vulnerability reporting (recommended)
  2. Direct Contact: Contact the maintainer directly through GitHub

πŸ“‹ What to Include

When reporting a security vulnerability, please include:

  • Description: Clear description of the vulnerability
  • Impact: Potential impact of the vulnerability
  • Steps to Reproduce: Detailed steps to reproduce (if applicable)
  • Proof of Concept: If possible, include a proof of concept
  • Suggested Fix: If you have ideas for a fix
  • Affected Versions: Which versions are affected

⏱️ Response Timeline

  • Initial Response: Within 48 hours
  • Status Update: Within 7 days
  • Fix Timeline: Depends on severity, but we aim for:
    • Critical: 7 days
    • High: 30 days
    • Medium: 90 days
    • Low: Next release cycle

πŸ›‘οΈ Security Best Practices

For Users

We care about your security. Here's how you can stay safe:

  • Keep Updated: Always use the latest version of the app
  • Official Sources Only: Download only from the App Store or GitHub releases
  • Report Issues: If you notice anything suspicious, please report it immediately
  • Review Permissions: The app requests minimal permissions (iCloud and Game Center, both optional)

For Contributors

If you're contributing code:

  • Review code before submitting
  • Follow secure coding practices
  • Never commit sensitive information (API keys, passwords, etc.)
  • Keep dependencies updated
  • Report security concerns through the proper channels

πŸ” Security Considerations

Data Privacy

  • Local Storage: Game data is stored locally or in iCloud
  • No Data Collection: We don't collect user data
  • Game Center: Uses Apple's Game Center (subject to Apple's privacy policy)
  • iCloud Sync: Uses Apple's iCloud (subject to Apple's privacy policy)

Permissions

SudoSodoku requests minimal permissions:

  • iCloud: For game state synchronization (optional)
  • Game Center: For user authentication and achievements (optional)

Third-Party Dependencies

Current dependencies:

  • SwiftUI: Apple framework
  • GameKit: Apple framework
  • Combine: Apple framework

We aim to minimize third-party dependencies and only use trusted, well-maintained libraries.

🚨 Known Security Issues

None at this time. All known security issues will be listed here once resolved.

πŸ“ Security Updates

Security updates will be:

  • Documented in CHANGELOG.md
  • Released as patch versions (e.g., 1.0.1, 1.0.2)
  • Communicated through GitHub releases
  • Prioritized over feature development

πŸ† Recognition

We deeply appreciate responsible disclosure of security vulnerabilities. Security researchers and contributors who help keep SudoSodoku secure will be:

  • Credited in security advisories (with your permission)
  • Acknowledged in release notes
  • Listed in this document (if you wish)

πŸ“š Additional Resources


Thank you for helping keep SudoSodoku secure! πŸ”’

There aren't any published security advisories