Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,14 @@ src/**/feeds.json
# playwright
.playwright-storage.json
.pw-user-data/

# AI tool artifacts
.claude/
CLAUDE.md
claude.md
planning.md
status.md
notes.md
todo.md
*.chat
*.conversation
92 changes: 92 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Comprehensive developer documentation platform for Palo Alto Networks
- Docusaurus 2-based static site generator with modern developer experience
- Aggregated developer-focused content across Palo Alto Networks products
- Open-source contribution model for community documentation improvements
- Multi-product documentation coverage with OpenAPI specifications

### Platform Features

**Documentation Site (pan.dev)**:
- **Docusaurus 2**: Modern static site generator with live reload
- **Markdown Authoring**: Easy-to-write documentation format
- **Contributing Guide**: Community contribution workflow and guidelines
- **Firebase Deployment**: Automated deployment from master branch
- **Build/Deploy Previews**: PR preview deployments for review

**Developer Tools**:
- **OpenAPI Specifications**: API documentation for Palo Alto Networks products
- **Code Examples**: Sample implementations and usage patterns
- **Interactive Docs**: API explorers and testing interfaces
- **Version Management**: Multi-version documentation support

### Content Organization

**Product Documentation**:
- Network security platform APIs
- Cloud-delivered security services
- Management and orchestration tools
- Developer SDKs and libraries
- Integration guides and tutorials

**Documentation Structure**:
- Products directory with auto-generated API docs
- Static site generation with Docusaurus config
- Custom plugins (GTM, OpenAPI integration)
- Localized content and internationalization support

### Technical Stack

**Core Technologies**:
- **Docusaurus 2**: React-based documentation framework
- **TypeScript**: Type-safe configuration and plugins
- **Yarn**: Package management and build tooling
- **Firebase**: Hosting and deployment platform
- **Playwright**: End-to-end testing framework

**Development Workflow**:
- Local development server with hot reload (`yarn start`)
- Production build generation (`yarn build`)
- Continuous integration with GitHub Actions
- Automated CodeQL security scanning
- Husky pre-commit hooks for code quality

### Community Contributions

**Open Source Model**:
- Public GitHub repository for community access
- Contribution guidelines for authors and editors
- Issue tracking for documentation improvements
- Pull request workflow with preview deployments
- Community-supported maintenance model

**Contributors**: Recognition for all community members who have contributed to improving the documentation

### Automation and CI/CD

**GitHub Actions**:
- Deploy Live workflow for production deployments
- CodeQL analysis for security scanning
- Automated build verification on pull requests
- Deploy preview generation for PR reviews

**Quality Assurance**:
- Prettier code formatting and linting
- Husky pre-commit hooks
- Playwright end-to-end testing
- GitLab CI/CD integration support

### Support Model

**Community-Supported**: As documented in SUPPORT.md, this documentation site follows Palo Alto Networks' community-supported policy with best-effort maintenance and expert contributions as available.

[Unreleased]: https://github.com/scthornton/pan.dev/commits/master
282 changes: 282 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,282 @@
# Security Policy

## Developer Documentation Platform

This repository contains the **pan.dev documentation platform**, a Docusaurus 2-based developer documentation site for Palo Alto Networks. This is a **community-supported open-source project** providing comprehensive developer resources and API documentation.

### Platform Purpose

**pan.dev** provides:
- ✅ Developer-focused documentation for Palo Alto Networks products
- ✅ OpenAPI specifications and API references
- ✅ Integration guides and code examples
- ✅ SDK documentation and tutorials
- ✅ Community-contributed content improvements

**Important:** This is a **documentation platform**. Security issues with Palo Alto Networks products should be reported through official security channels (see below).

## Reporting Security Issues

### Documentation Platform Security

**For security issues with the pan.dev documentation site itself** (not products):

**Email:** scott@perfecxion.ai

Report issues such as:
- XSS vulnerabilities in the documentation platform
- Malicious code in site infrastructure
- Security issues with the Docusaurus setup
- Vulnerable dependencies in package.json
- Build or deployment pipeline security concerns

**Response Timeline:**
- **Initial Response**: Within 48 hours
- **Assessment**: Within 7 days
- **Resolution**: Based on severity

### Product Security Issues

**For security vulnerabilities in Palo Alto Networks products** (not the documentation site):

**Palo Alto Networks Security Advisory**:
- Visit: https://security.paloaltonetworks.com/
- Email: psirt@paloaltonetworks.com

**Scope**: All security issues related to:
- Network security products and services
- Cloud-delivered security services
- APIs and SDKs (product functionality, not docs)
- Product vulnerabilities or exploits

**Separation of Concerns**:
- **Documentation site security** → scott@perfecxion.ai (this repository)
- **Product security** → psirt@paloaltonetworks.com (official PSIRT)

## Documentation Site Security

### Static Site Security

**Architecture**:
- Docusaurus 2 static site generator (React-based)
- All content pre-generated as HTML/CSS/JavaScript
- No server-side code execution
- No database or user data storage
- Firebase hosting with HTTPS encryption

**Security Features**:
- Static content delivery (no dynamic execution)
- HTTPS enabled for all connections
- GitHub Actions security scanning (CodeQL)
- Dependency vulnerability monitoring
- No user authentication or session management

### Content Security

**Documentation Guidelines**:
- All code examples reviewed before publication
- No credentials, API keys, or secrets in examples
- Sanitized logs and configurations
- Placeholder values for sensitive data
- Security warnings in appropriate sections

**OpenAPI Security**:
- API specifications reviewed for sensitive data exposure
- No real credentials in API examples
- Authentication guidance clearly documented
- Security best practices included in API docs

## Supported Versions

| Version | Supported |
| ------- | ------------------ |
| master | :white_check_mark: |

**Note**: The master branch is the live production branch for pan.dev and receives continuous updates.

## Security Best Practices

### For Contributors

**1. Content Security**
- Review all code examples for security issues
- Remove any credentials or API keys before committing
- Use placeholder values (e.g., `YOUR_API_KEY`)
- Include security warnings for risky operations
- Test code examples in isolated environments

**2. Dependency Management**
- Keep Docusaurus and plugins updated
- Review dependency security advisories
- Run `yarn audit` regularly
- Update vulnerable dependencies promptly
- Follow semantic versioning for updates

**3. Code Quality**
- Use Prettier for consistent formatting
- Follow TypeScript best practices
- Enable ESLint security rules
- Run pre-commit hooks (Husky)
- Validate builds before committing

**4. API Documentation**
- Never include real API credentials
- Document authentication requirements clearly
- Provide security best practices for each API
- Highlight rate limiting and access control
- Include error handling guidance

### For Documentation Users

**1. Code Example Usage**
- Verify examples before implementing in production
- Replace placeholder values with real credentials securely
- Follow security best practices for your environment
- Don't hardcode credentials in source code
- Use environment variables or secrets management

**2. API Security**
- Follow authentication guidelines carefully
- Implement proper access control
- Use TLS/SSL for all API communications
- Rotate API keys regularly
- Monitor API usage for anomalies

**3. Responsible Disclosure**
- If you discover vulnerabilities in products, contact psirt@paloaltonetworks.com
- Follow responsible disclosure timelines (90 days)
- Don't publicly disclose before vendor coordination
- Provide clear reproduction steps

## Dependency Security

### Automated Scanning

**GitHub Actions**:
- CodeQL analysis on all commits
- Dependency vulnerability scanning
- Automated security updates via Dependabot

**Manual Reviews**:
- Quarterly dependency audit (`yarn audit`)
- Review of critical security advisories
- Evaluation of dependency alternatives
- Update strategy for breaking changes

### Known Dependencies

**Core Dependencies**:
- Docusaurus 2 (documentation framework)
- React (UI library)
- TypeScript (type safety)
- Prettier (code formatting)
- Playwright (end-to-end testing)

**Security Considerations**:
- All dependencies pinned in package.json
- Lock file (yarn.lock) committed to repository
- Regular updates via GitHub Actions and Dependabot
- Security advisories monitored continuously

## Build and Deployment Security

### GitHub Actions

**Workflows**:
- `deploy-live.yml`: Production deployment to Firebase
- `codeql-analysis.yml`: Security scanning with CodeQL

**Security Measures**:
- Secrets stored in GitHub Actions secrets
- Limited workflow permissions (principle of least privilege)
- Branch protection rules on master
- Required reviews for pull requests
- Automated security checks before merge

### Firebase Deployment

**Security**:
- HTTPS enforced for all connections
- Firebase security rules configured
- Access logs enabled for monitoring
- Automated deployment from master only
- Preview deployments isolated per PR

## Community Support Model

### Support Policy

As documented in [SUPPORT.md](SUPPORT.md), this project follows Palo Alto Networks' **community-supported policy**:

- Best-effort support from community and Palo Alto Networks experts
- No SLA or guaranteed response times
- Product support through official channels only
- Documentation improvements welcomed via pull requests
- Security issues prioritized for rapid response

### Contribution Security

**Pull Request Review**:
- All PRs require review before merge
- Security-focused code review for sensitive changes
- Automated checks (linting, testing, security scanning)
- Preview deployments for validation
- Community feedback period for major changes

## Privacy

### No Personal Data Collection

**Documentation Site**:
- No user accounts or authentication
- No cookies or local storage of personal data
- No tracking scripts or analytics by default
- Public content only (no private data)

**Third-Party Services**:
- Firebase hosting (aggregate statistics only)
- GitHub (standard repository access logs)
- Google Tag Manager (if configured, respects DNT)

## Compliance

### Open Source Licensing

**Repository License**: See [LICENSE](LICENSE)
- Open source project with community contributions
- Attribution required per license terms
- Derivative works subject to license restrictions

### Content Attribution

**Documentation Standards**:
- Proper attribution for third-party content
- Respect for intellectual property
- Fair use of referenced materials
- Linking to original sources

## Contact

### Security Concerns

**Documentation Site Issues**: scott@perfecxion.ai
**Product Security Issues**: psirt@paloaltonetworks.com

### General Contact

- **Email:** scott@perfecxion.ai
- **Alternative:** scthornton@gmail.com
- **GitHub:** [@scthornton](https://github.com/scthornton)

For questions about this documentation platform repository (not product security), contact scott@perfecxion.ai.

### Official Palo Alto Networks Resources

- **Security Advisories**: https://security.paloaltonetworks.com/
- **PSIRT Email**: psirt@paloaltonetworks.com
- **Support Portal**: https://support.paloaltonetworks.com/
- **Developer Resources**: https://pan.dev/

---

**Note**: This SECURITY.md covers the pan.dev documentation platform repository. For security issues with Palo Alto Networks products, use official security reporting channels (psirt@paloaltonetworks.com).
Loading