138 Commits (v3.0.5)

Author	SHA1	Message	Date
Rene Cannao	8c90bda52a	Address gemini-code-assist review comments for SSL keylog documentation ... This commit addresses all review comments from gemini-code-assist on PR #5279: 1. Fixed FLUSH LOGS documentation - clarified that file is reopened for appending, not truncating, and updated the note about preserving contents 2. Fixed callback documentation - clarified that the callback attaches to all frontend connections, not just admin connections 3. Updated security warning - focused on passive eavesdropping and offline decryption as the primary threats 4. Fixed typo: proxyql_ip -> proxysql_ip in tcpdump example 5. Removed misleading @see HPKP link - HPKP is unrelated to NSS Key Log Format and is a deprecated feature 6. Updated NSS Key Log Format URL to use official MDN link instead of unofficial mirror 7. Fixed buffer size comment to accurately reflect 256-byte buffer and 254-byte line length validation 8. Clarified fputs comment to emphasize the read lock's role in allowing concurrent writes from multiple threads	4 months ago
Rene Cannao	442635b721	Add comprehensive documentation for SSL/TLS key logging feature ... This commit adds extensive documentation for the ssl_keylog_file feature (introduced in PR #4236), which enables TLS key logging for debugging encrypted traffic. ## Background The ssl_keylog_file variable (exposed as admin-ssl_keylog_file in SQL interface) allows ProxySQL to write TLS secrets to a file in NSS Key Log Format. These secrets can be used by tools like Wireshark and tshark to decrypt and analyze TLS traffic for debugging purposes. ## Changes ### Inline Documentation (Code) 1. include/proxysql_sslkeylog.h (+96 lines) - File-level documentation explaining the module purpose and security - Doxygen comments for all 5 public APIs - Thread-safety annotations - Parameter descriptions and return values 2. lib/proxysql_sslkeylog.cpp (+136 lines) - Implementation-level documentation - Algorithm explanations (double-checked locking, thread safety) - Reference to NSS Key Log Format specification 3. include/proxysql_admin.h (+19 lines) - Variable documentation for ssl_keylog_file - Path handling rules (absolute vs relative) - Security implications ### Developer Documentation (doc/ssl_keylog/ssl_keylog_developer_guide.md) Target audience: Developers working on ProxySQL codebase Contents: - Variable naming convention (SQL vs config file vs internal) - Architecture diagrams - Thread safety model (pthread rwlock) - NSS Key Log Format specification - Complete API reference for all public functions - Integration points in the codebase - Security considerations and code review checklist - Testing procedures ### User Documentation (doc/ssl_keylog/ssl_keylog_user_guide.md) Target audience: End users and system administrators Contents: - What is SSL key logging and when to use it - Variable naming: admin-ssl_keylog_file (SQL) vs ssl_keylog_file (config) - Step-by-step enable/disable instructions - Path resolution (absolute vs relative) - Log rotation procedures - Production workflow: tcpdump capture → offline analysis - Wireshark (GUI) integration tutorial - tshark (command-line) usage examples - Troubleshooting common issues - Security best practices - Quick reference card ## Key Features Documented 1. **Variable Naming Convention** - SQL interface: SET admin-ssl_keylog_file = '/path'; - Config file: ssl_keylog_file='/path' (in admin_variables section) - Internal code: ssl_keylog_file 2. **Production Workflow** - Capture traffic with tcpdump (no GUI on production server) - Transfer pcap + keylog to analysis system - Analyze offline with Wireshark (GUI) or tshark (CLI) 3. **tshark Examples** - Command-line analysis of encrypted traffic - Filter examples for debugging TLS issues - JSON export for automated analysis ## Security Notes The documentation emphasizes that: - Key log files contain cryptographic secrets that decrypt ALL TLS traffic - Access must be restricted (permissions 0600) - Only enable for debugging, never in production - Securely delete old key log files ## Files Modified - include/proxysql_admin.h - include/proxysql_sslkeylog.h - lib/proxysql_sslkeylog.cpp ## Files Added - doc/ssl_keylog/ssl_keylog_developer_guide.md - doc/ssl_keylog/ssl_keylog_user_guide.md	4 months ago
Wazir Ahmed	facba20055	doc: Add information about groups in TAP test guide ... Signed-off-by: Wazir Ahmed <wazir@proxysql.com>	4 months ago
Wazir Ahmed	67ca39e248	doc: Update TAP documentation with unit test instructions ... Signed-off-by: Wazir Ahmed <wazir@proxysql.com>	4 months ago
Rene Cannao	cf8cbfd89a	Document coredump_filters feature (issue #5213) ... Add comprehensive documentation for the on‑demand core dump generation feature introduced in PR #4225. The documentation covers: - coredump_filters and runtime_coredump_filters table definitions - LOAD COREDUMP TO RUNTIME admin command and its aliases - Configuration variables admin‑coredump_generation_threshold and admin‑coredump_generation_interval_ms - Usage examples with INSERT and LOAD commands - Important notes about case‑sensitive filenames, runtime‑only behavior, rate limiting, and platform support - Troubleshooting guidance and best practices The documentation addresses the missing documentation reported in GitHub issue #5213.	4 months ago
Rene Cannao	de214cb558	Add comprehensive documentation for "Closing killed client connection" warnings	4 months ago
Rene Cannao	6966b79db9	Add documentation for query rules capture groups and backreferences	4 months ago
Rene Cannao	291e5f02a9	Add AI disclaimer to ENHANCEMENT-OPPORTUNITIES.md	5 months ago
Rene Cannao	54091905c1	Restructure AI-generated documentation with verification framework ... - Move AI-generated docs to doc/ai-generated/ folder for clear separation - Add AI disclaimers to all documentation files (Status: NON-VERIFIED) - Create AI-DOCUMENTATION-FRAMEWORK.md explaining the tiered approach - Add doc/README.md as main navigation guide - Maintain transparency about AI documentation limitations - Reduce verification burden while preserving exploration value All AI-generated docs now clearly state they are starting points for exploration and should be verified against actual source code.	5 months ago
René Cannaò	9713f87be7	Merge branch 'v3.0' into v3.0.agentics ... Signed-off-by: René Cannaò <rene@proxysql.com>	5 months ago
noizu	39f94b0f6f	simplify for pr	5 months ago
Rene Cannao	546c10128c	docs: Add TAP test writing guide for ProxySQL.	5 months ago
noizu	d946b6e3d3	updates from internal docs	7 months ago
noizu	89849d0dc0	patch	7 months ago
noizu	5f15d971fe	patch	7 months ago
noizu	4dad6424ef	doc update	7 months ago
noizu	9e337ce739	TEST-PIPELINE.md doc	7 months ago
noizu	e2e8d8c4d4	doc cleanup - remove agenetic verbage and mermaid patch	7 months ago
noizu	ab2a32924e	Visual Guide v0.1 checkin	7 months ago
noizu	fbbefb9102	initial arch entry point for agents	7 months ago
René Cannaò	d913cb9972	Added detailed documentation ... Added detailed documentation for Logging of prepared statements parameters	1 year ago
René Cannaò	6c7c0cc2b5	Create MySQL_Session.md	2 years ago
René Cannaò	df0e36e854	Create MySQL_Connection.md	2 years ago
René Cannaò	c3c9746bbc	Merge branch 'v2.x' into v2.x_sha2pass_draft3	2 years ago
René Cannaò	f9b3b70636	Create ProxySQL_Authentication.md	3 years ago
Rahim Kanji	249f023fbe	Added ProxySQL Cluster internal working documentation and flowchart ... TODO: Update documentation: mysql_servers_v2	3 years ago
René Cannaò	449f4eb659	Adding debug_filters	6 years ago
René Cannaò	3ffe68d178	Added first documentation on PROXYSQLTEST	6 years ago
René Cannaò	8c4ba5ba42	Updated doc on global variables	8 years ago
René Cannaò	a51b040b4a	Updated release note	8 years ago
René Cannaò	52c56025e0	Updated release note	8 years ago
René Cannaò	fb469f266a	Updating release note	8 years ago
René Cannaò	943cdfc335	Updating release note	8 years ago
René Cannaò	07183535c4	Update ProxySQL_v1.4.4.md	8 years ago
René Cannaò	eecb4fe9af	Added curl	8 years ago
Nikolaos Vyzas	03eca20bf9	Removing files merged to WIKI	8 years ago
Erik Mathis	b72d29c792	Noted that multiple admin used can be specified. ... https://groups.google.com/d/msg/proxysql/Di6szGG76wk/xoTbjUmQAgAJ	9 years ago
everpcpc	d44838b572	add option autocommit_false_not_reusable	9 years ago
René Cannaò	a217e4fa3d	Updating doc #976	9 years ago
René Cannaò	238ca17f6d	Merging PR #931 and #1035	9 years ago
René Cannaò	b0dfe97ec6	Removed incorrect notes in 1.3.2 release note ... Conflicts: doc/release_notes/ProxySQL_v1.3.2.md	9 years ago
René Cannaò	c22787f881	Added release note for 1.3.3	9 years ago
René Cannaò	4d4b14ea20	Renamed Latency_ms to Latency_us #882 ... Updated also the documentation	9 years ago
Domenico Lupinetti	e15d7c1bd3	Updated documentation ... Column time_start does not exists anymore. Changed to: ```time_start_us```	9 years ago
Oloruntobi Ogunbiyi	e5723d2d95	Update minor issues with Admin interface and Query cache docs	9 years ago
René Cannaò	afea6885b8	Merge branch 'v1.3.0' into v1.3.1-20161127 ... Conflicts: lib/mysql_connection.cpp	10 years ago
René Cannaò	ffa266ed06	Added release note for v1.3.0g	10 years ago
René Cannaò	193baf70bb	Updating doc	10 years ago
René Cannaò	7f039840d1	Add doc on new columns in mysql_query_rules ... also fixed some typo	10 years ago
René Cannaò	c608771d14	Update ProxySQL_v1.3.0.md	10 years ago