Fixing documentations

Author: stevefan1999-personal

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+## Contributing
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
+
+## Tips
+When contributing to this test crate:
+
+1. Maintain compatibility with ESP32 variants
+2. Keep memory usage optimized
+3. Add comprehensive logging
+4. Update documentation for any changes
+5. Test on physical hardware when possible
+
+## Related Documentation
+
+- [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/)
+- [Rust on ESP32](https://esp-rs.github.io/book/)
+- [rustls Documentation](https://docs.rs/rustls/)
+- [RustCrypto Documentation](https://docs.rs/rustcrypto/)
+- [RustCrypto GitHub organization](https://github.com/RustCrypto)
+
+## Testing Strategy
+
+### Unit Tests
+```bash
+cargo test -p rustls-real-socket-test
+```
+
+### Integration Tests
+```bash
+cargo test --test integration
+```

README.md

@@ -162,12 +162,6 @@ at your option.
 
 Some code authored by [@ctz](https://github.com/ctz) was adapted from upstream rustls. Licensed as above with permission.
 
-### Contribution
-
-Unless you explicitly state otherwise, any contribution intentionally submitted
-for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
-dual licensed as above, without any additional terms or conditions.
-
 [//]: # "badges"
 [crate-image]: https://img.shields.io/crates/v/rustls-rustcrypto
 [crate-link]: https://crates.io/crates/rustls-rustcrypto
@@ -181,4 +175,4 @@ dual licensed as above, without any additional terms or conditions.
 [chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/434751-TLS
 [//]: # "links"
 [RustCrypto]: https://github.com/RustCrypto/
-[rustls]: https://github.com/rustls/rustls/
+[rustls]: https://github.com/rustls/rustls/

SECURITY.md

@@ -0,0 +1,22 @@
+### Certificates
+
+The two tests (real socket test and ESP32 test) uses embedded certificates (for now):
+- **Server Certificate**: `cert.der` - ECDSA P-256 certificate
+- **Private Key**: `key.der` - PKCS#8 encoded private key
+- **Certificate Verification**: Custom verifier (accepts all for testing)
+
+### Security Notes
+
+⚠️ **WARNING**: The tests uses a dummy certificate verifier that accepts all certificates. This is for testing purposes only and should NEVER be used in production code.
+
+## Performance Considerations for embedded
+
+### Memory Usage
+- Optimized for ESP32's limited RAM
+- Uses static allocations where possible
+- Minimal heap allocation during runtime
+
+### CPU Usage
+- ECC operations are computationally intensive
+- Consider using hardware acceleration if available
+- Profile with ESP-IDF tools for optimization

TROUBLESHOOTING.md

@@ -0,0 +1,43 @@
+## Troubleshooting (for ESP32 integration test)
+
+### Common Issues
+
+#### Build Failures
+- Ensure ESP-IDF is properly installed and sourced
+- Check Rust toolchain version compatibility
+- Verify target architecture matches your ESP32 variant
+
+#### Flashing Issues
+- Check USB port permissions
+- Ensure no other processes are using the serial port
+- Try different USB cables or ports
+
+#### Runtime Errors
+- Verify network connectivity if using WiFi
+- Check ESP32 power supply stability
+- Monitor serial output for detailed error messages
+
+#### TLS Handshake Failures
+- Ensure certificates are properly embedded
+- Check cipher suite compatibility
+- Verify TLS version support
+
+### Debugging
+
+Enable detailed logging:
+```bash
+# Set log level
+espmonitor /dev/ttyUSB0 -e "RUST_LOG=trace"
+```
+
+Common debug commands:
+```bash
+# Check ESP32 connection
+ls /dev/ttyUSB*
+
+# Monitor with specific baud rate
+espmonitor /dev/ttyUSB0 --baud 115200
+
+# Flash with verbose output
+cargo espflash flash --release --verbose
+```

validation/README.md

@@ -135,32 +135,6 @@ cargo run -p esp32-test
 - OpenSSL development libraries
 - Custom certificate generation tools
 
-## Configuration
-
-### Feature Flags
-
-Most crates support various feature flags to customize the build:
-
-```toml
-[dependencies.rustls-rustcrypto]
-version = "0.0.2-alpha"
-path = "../.."
-default-features = false
-features = [
-    "aead-chacha20poly1305",
-    "alloc",
-    "der",
-    "ecdsa-p256",
-    "fast",
-    "kx-p256",
-    "pkcs8",
-    "sign-ecdsa-p256",
-    "tls12",
-    "verify-ecdsa-p256",
-    "verify-ecdsa-p256-sha256"
-]
-```
-
 ### Environment Variables
 
 - `RUST_LOG`: Set logging level (e.g., `RUST_LOG=trace`)
@@ -176,54 +150,6 @@ These validation crates are designed with the following principles:
 4. **Cross-Platform**: Support multiple target architectures
 5. **Extensibility**: Easy to add new test scenarios
 
-## Troubleshooting
-
-### Common Issues
-
-#### ESP32 Build Failures
-- Ensure ESP-IDF is properly installed and configured
-- Check that the correct Rust toolchain is selected
-- Verify ESP32 hardware connections if running on device
-
-#### OpenSSL Compatibility Issues
-- Ensure OpenSSL development libraries are installed
-- Check certificate generation scripts in `certs/` directory
-- Verify OpenSSL version compatibility
-
-#### no_std Compilation Errors
-- Use `--no-default-features` flag
-- Ensure all dependencies support no_std
-- Check for std-specific code in dependencies
-
-#### Network Socket Issues
-- Ensure no firewall blocking local connections
-- Check that ports are available (tests use random ports)
-- Verify network interface configuration
-
-### Debugging
-
-Enable detailed logging:
-
-```bash
-RUST_LOG=trace cargo run -p <crate_name>
-```
-
-For ESP32, use ESP-IDF logging facilities.
-
-## Contributing
-
-When adding new validation crates:
-
-1. Create a new directory under `validation/`
-2. Add a dedicated `Cargo.toml` with minimal dependencies
-3. Include a `README.md` with crate-specific documentation
-4. Update this main README.md
-5. Add appropriate CI/CD configuration if needed
-
-## License
-
-These validation crates follow the same license as the main rustls-rustcrypto project: Apache-2.0 or MIT.
-
 ---
 
 These live in the workspace due to different dependency requirements between tests where development-deps may pollute the integration under test.