Skip to content
This repository was archived by the owner on Jun 3, 2026. It is now read-only.

Commit 6bdd211

Browse files
SebaB29SebaB29
authored
Add Documentation
1 parent 08428e0 commit 6bdd211

6 files changed

Lines changed: 285 additions & 8 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing to RoomRTC
2+
3+
Thank you for your interest in contributing to RoomRTC! We welcome contributions from the community.
4+
5+
## How to Contribute
6+
7+
### Reporting Issues
8+
9+
- Check if the issue already exists in the issue tracker
10+
- Use a clear and descriptive title
11+
- Provide detailed steps to reproduce the problem
12+
- Include relevant logs, screenshots, or code samples
13+
14+
### Submitting Changes
15+
16+
1. **Fork the repository** and create your branch from `main`
17+
2. **Make your changes** following our coding standards
18+
3. **Test your changes** thoroughly
19+
4. **Commit your changes** with clear, descriptive commit messages
20+
5. **Push to your fork** and submit a pull request
21+
22+
### Pull Request Guidelines
23+
24+
- Provide a clear description of the changes
25+
- Reference any related issues
26+
- Ensure all tests pass
27+
- Update documentation as needed
28+
- Keep pull requests focused on a single concern
29+
30+
### Code Style
31+
32+
- Follow the existing code style in the project
33+
- Write clear, readable code with appropriate comments
34+
- Keep functions small and focused
35+
36+
### Development Setup
37+
38+
1. Clone the repository
39+
2. Install dependencies
40+
3. Create a new branch for your feature or fix
41+
4. Make your changes and test locally
42+
43+
## Code of Conduct
44+
45+
Please be respectful and constructive in all interactions. We are committed to providing a welcoming and inclusive environment for all contributors.
46+
47+
## Questions?
48+
49+
Feel free to open an issue for questions or clarifications about contributing.
50+
51+
Thank you for contributing to RoomRTC!

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Issue Template
2+
3+
## Issue Type
4+
- [ ] Bug Report
5+
- [ ] Feature Request
6+
- [ ] Documentation Update
7+
- [ ] Question
8+
- [ ] Other
9+
10+
## Description
11+
A clear and concise description of the issue.
12+
13+
## Steps to Reproduce (for bugs)
14+
1. Go to '...'
15+
2. Click on '...'
16+
3. Scroll down to '...'
17+
4. See error
18+
19+
## Expected Behavior
20+
What you expected to happen.
21+
22+
## Actual Behavior
23+
What actually happened.
24+
25+
## Screenshots
26+
If applicable, add screenshots to help explain your problem.
27+
28+
## Environment (if relevant)
29+
- OS: [e.g. Windows, macOS, Linux]
30+
- Browser: [e.g. Chrome, Firefox, Safari]
31+
- Version: [e.g. 1.0.0]
32+
33+
## Additional Context
34+
Add any other context about the problem here.
35+
36+
## Possible Solution (optional)
37+
If you have suggestions on how to fix the issue.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Description
2+
3+
Please include a summary of the changes and the related issue. Explain the motivation and context for this pull request.
4+
5+
Fixes # (issue)
6+
7+
## Type of Change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Code refactoring
16+
- [ ] Performance improvement
17+
- [ ] Other (please describe):
18+
19+
## How Has This Been Tested?
20+
21+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
22+
23+
- [ ] Test A
24+
- [ ] Test B
25+
26+
**Test Configuration**:
27+
* Browser/Environment:
28+
* Version:
29+
30+
## Checklist
31+
32+
- [ ] My code follows the style guidelines of this project
33+
- [ ] I have performed a self-review of my own code
34+
- [ ] I have commented my code, particularly in hard-to-understand areas
35+
- [ ] I have made corresponding changes to the documentation
36+
- [ ] My changes generate no new warnings
37+
- [ ] I have added tests that prove my fix is effective or that my feature works
38+
- [ ] New and existing unit tests pass locally with my changes
39+
- [ ] Any dependent changes have been merged and published
40+
41+
## Screenshots (if applicable)
42+
43+
Add screenshots to help explain your changes.
44+
45+
## Additional Notes
46+
47+
Add any other context about the pull request here.

‎.github/SECURITY.md‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We release patches for security vulnerabilities in the following versions:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 1.x.x | :white_check_mark: |
10+
| < 1.0 | :x: |
11+
12+
**Note:** We recommend always using the latest stable version to ensure you have all security updates and patches.
13+
14+
## Reporting a Vulnerability
15+
16+
We take the security of RoomRTC seriously. If you believe you have found a security vulnerability, please report it to us as described below.
17+
18+
### How to Report
19+
20+
**Please do NOT report security vulnerabilities through public GitHub issues.**
21+
22+
Instead, please report security vulnerabilities by:
23+
24+
1. **Email**: Send an email to sebita29@gmail.com
25+
2. **Subject Line**: Include "RoomRTC Security Vulnerability" in the subject
26+
3. **Details to Include**:
27+
- Type of vulnerability
28+
- Full paths of source file(s) related to the vulnerability
29+
- Location of the affected source code (tag/branch/commit or direct URL)
30+
- Step-by-step instructions to reproduce the issue
31+
- Proof-of-concept or exploit code (if possible)
32+
- Impact of the vulnerability, including how an attacker might exploit it
33+
34+
### What to Expect
35+
36+
- **Acknowledgment**: You should receive an acknowledgment within 48 hours
37+
- **Investigation**: We will investigate and validate the reported vulnerability
38+
- **Updates**: We will keep you informed about the progress of the fix
39+
- **Resolution**: Once the vulnerability is fixed, we will notify you and publicly acknowledge your responsible disclosure (unless you prefer to remain anonymous)
40+
- **Timeline**: We aim to resolve critical vulnerabilities within 30 days
41+
42+
### Disclosure Policy
43+
44+
- Please give us reasonable time to address the vulnerability before any public disclosure
45+
- We will credit you for the discovery in our security advisories (unless you prefer anonymity)
46+
- We follow coordinated disclosure practices
47+
48+
## Security Best Practices
49+
50+
### For Users
51+
52+
1. **Keep Updated**: Always use the latest stable version of RoomRTC
53+
2. **Secure Configuration**:
54+
- Use strong, unique passwords for any authentication
55+
- Enable HTTPS/WSS for all WebRTC connections
56+
- Configure proper CORS policies
57+
3. **Network Security**:
58+
- Use TURN servers with authentication
59+
- Implement proper firewall rules
60+
- Validate and sanitize all user inputs
61+
4. **Monitoring**:
62+
- Monitor your application logs for suspicious activity
63+
- Set up alerts for unusual connection patterns
64+
65+
### For Developers
66+
67+
1. **Secure Coding Practices**:
68+
- Validate and sanitize all inputs, especially signaling data
69+
- Use parameterized queries to prevent injection attacks
70+
- Implement proper authentication and authorization
71+
- Follow the principle of least privilege
72+
73+
2. **WebRTC Security**:
74+
- Always use HTTPS for serving WebRTC applications
75+
- Use WSS (WebSocket Secure) for signaling
76+
- Implement proper STUN/TURN server authentication
77+
- Validate peer connections before establishing media streams
78+
79+
3. **Dependencies**:
80+
- Regularly update all dependencies
81+
- Use tools like `npm audit` or `yarn audit` to check for known vulnerabilities
82+
- Review dependency licenses and security advisories
83+
84+
4. **Data Protection**:
85+
- Implement end-to-end encryption for sensitive data
86+
- Don't store sensitive information in logs
87+
- Follow GDPR and other relevant data protection regulations
88+
- Use secure token generation for session management
89+
90+
5. **Code Review**:
91+
- Conduct security-focused code reviews
92+
- Use static analysis tools to identify potential vulnerabilities
93+
- Implement automated security testing in CI/CD pipelines
94+
95+
### Security Checklist
96+
97+
Before deploying RoomRTC in production:
98+
99+
- [ ] All communications use HTTPS/WSS
100+
- [ ] Authentication is properly implemented
101+
- [ ] Input validation is in place for all user inputs
102+
- [ ] CORS policies are correctly configured
103+
- [ ] Rate limiting is implemented to prevent DoS attacks
104+
- [ ] Error messages don't expose sensitive information
105+
- [ ] Security headers are properly configured
106+
- [ ] Dependencies are up to date
107+
- [ ] Logging doesn't include sensitive data
108+
- [ ] Security testing has been performed
109+
110+
## Known Security Considerations
111+
112+
### WebRTC Specific
113+
114+
1. **IP Address Exposure**: WebRTC can expose users' real IP addresses even when using a VPN. Consider:
115+
- Implementing IP masking via TURN servers
116+
- Warning users about potential IP exposure
117+
- Providing configuration options for privacy-conscious users
118+
119+
2. **Cross-Site Scripting (XSS)**: Ensure all user-generated content is properly sanitized
120+
121+
3. **Man-in-the-Middle Attacks**: Always use encrypted connections and verify peer identities
122+
123+
## Security Updates
124+
125+
Security updates and patches will be announced through:
126+
- GitHub Security Advisories
127+
- Release notes
128+
- Project README
129+
130+
Subscribe to repository releases to stay informed about security updates.
131+
132+
## Additional Resources
133+
134+
- [WebRTC Security Architecture](https://datatracker.ietf.org/doc/html/rfc8827)
135+
- [OWASP WebRTC Security Guidelines](https://owasp.org/)
136+
- [MDN Web Security](https://developer.mozilla.org/en-US/docs/Web/Security)
137+
138+
---
139+
140+
**Last Updated**: 2025-12-17
141+
142+
Thank you for helping keep RoomRTC and its users safe!

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 taller-1-fiuba-rust
3+
Copyright (c) 2025 Sebastian Brizuela
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ This repository contains all source code, documentation, and configuration files
3434
<a name="team"></a>
3535
## 👥 Team Members
3636

37-
| StudentID | Name |
38-
| :-------: | :------ |
39-
| 103384 | Adriana Macarena Iglesias Tripodi |
40-
| 105288 | Sebastián Brizuela |
41-
| 105400 | Franco Altieri Lamas |
42-
| 105907 | Nicolás Chen |
37+
| StudentID | Name | Github |
38+
| :-------: | :-------------------------------- | :----------------------------------------------- |
39+
| 103384 | Adriana Macarena Iglesias Tripodi | [AIglesiasT](https://github.com/AIglesiasT) |
40+
| 105288 | Sebastián Brizuela | [SebaB29](https://github.com/SebaB29) |
41+
| 105400 | Franco Altieri Lamas | [FrancoAltieri](https://github.com/FrancoAltieri) |
42+
| 105907 | Nicolás Chen | [nichen710](https://github.com/nichen710) |
4343

4444
<a name="about"></a>
4545
## ℹ️ About the Project
@@ -221,4 +221,4 @@ This repository includes a `LICENSE` file. Please refer to it for detailed licen
221221

222222
---
223223

224-
**Developed with 🦀 by Rusty Coders | Taller de Programación I - FIUBA - 2025**
224+
**Developed with 🦀 by Rusty Coders | Taller de Programación I - FIUBA - 2025**

0 commit comments

Comments
 (0)