# zschema sub-schema for zgrab2's mysql module (modules/mysql.go)
# Registers zgrab2-mysql globally, and mysql with the main zgrab2 schema.
from zschema.leaves import *
from zschema.compounds import *
import zschema.registry

import schemas.zcrypto as zcrypto
import schemas.zgrab2 as zgrab2

from schemas.zgrab2 import DebugOnly

# zgrab2/lib/mysql/mysql.go: GetServerStatusFlags()
mysql_server_status_flags = {
		"SERVER_STATUS_IN_TRANS": Boolean(),
		"SERVER_STATUS_AUTOCOMMIT": Boolean(),
		"SERVER_MORE_RESULTS_EXISTS": Boolean(),
		"SERVER_QUERY_NO_GOOD_INDEX_USED": Boolean(),
		"SERVER_QUERY_NO_INDEX_USED": Boolean(),
		"SERVER_STATUS_CURSOR_EXISTS": Boolean(),
		"SERVER_STATUS_LAST_ROW_SENT": Boolean(),
		"SERVER_STATUS_DB_DROPPED": Boolean(),
		"SERVER_STATUS_NO_BACKSLASH_ESCAPES": Boolean(),
		"SERVER_STATUS_METADATA_CHANGED": Boolean(),
		"SERVER_QUERY_WAS_SLOW": Boolean(),
		"SERVER_PS_OUT_PARAMS": Boolean(),
		"SERVER_STATUS_IN_TRANS_READONLY": Boolean(),
		"SERVER_SESSION_STATE_CHANGED": Boolean()
}

# zgrab2/lib/mysql/mysql.go: GetClientCapabilityFlags()
mysql_capability_flags = {
		"CLIENT_LONG_PASSWORD": Boolean(),
		"CLIENT_FOUND_ROWS": Boolean(),
		"CLIENT_LONG_FLAG": Boolean(),
		"CLIENT_CONNECT_WITH_DB": Boolean(),
		"CLIENT_NO_SCHEMA": Boolean(),
		"CLIENT_COMPRESS": Boolean(),
		"CLIENT_ODBC": Boolean(),
		"CLIENT_LOCAL_FILES": Boolean(),
		"CLIENT_IGNORE_SPACE": Boolean(),
		"CLIENT_PROTOCOL_41": Boolean(),
		"CLIENT_INTERACTIVE": Boolean(),
		"CLIENT_SSL": Boolean(),
		"CLIENT_IGNORE_SIGPIPE": Boolean(),
		"CLIENT_TRANSACTIONS": Boolean(),
		"CLIENT_RESERVED": Boolean(),
		"CLIENT_SECURE_CONNECTION": Boolean(),
		"CLIENT_MULTI_STATEMENTS": Boolean(),
		"CLIENT_MULTI_RESULTS": Boolean(),
		"CLIENT_PS_MULTI_RESULTS": Boolean(),
		"CLIENT_PLUGIN_AUTH": Boolean(),
		"CLIENT_CONNECT_ATTRS": Boolean(),
		"CLIENT_PLUGIN_AUTH_LEN_ENC_CLIENT_DATA": Boolean(),
		"CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS": Boolean(),
		"CLIENT_SESSION_TRACK": Boolean(),
		"CLIENT_DEPRECATED_EOF": Boolean()
}

# zgrab2/modules/mysql.go: MySQLScanResults
mysql_scan_response = SubRecord({
    "result": SubRecord({
        "protocol_version": Unsigned8BitInteger(required = True),
        "server_version": String(required = True),
        "connection_id": DebugOnly(Unsigned32BitInteger()),
        "auth_plugin_data": DebugOnly(Binary()),
        "capability_flags": SubRecord(mysql_capability_flags, required = True),
        "character_set": DebugOnly(Unsigned8BitInteger()),
        "status_flags": SubRecord(mysql_server_status_flags, required = False),
        "auth_plugin_name": DebugOnly(String()),
        "error_code": Signed32BitInteger(),
        "error_message": String(),
        "raw_packets": ListOf(Binary()),
        "tls": zgrab2.tls_log,
    })
}, extends = zgrab2.base_scan_response)

zschema.registry.register_schema("zgrab2-mysql", mysql_scan_response)

zgrab2.register_scan_response_type('mysql', mysql_scan_response)