|
| 1 | +import dataclasses |
| 2 | +import logging |
| 3 | +import typing as t |
| 4 | + |
| 5 | +import cratedb_sqlparse |
| 6 | +import sqlparse |
| 7 | + |
| 8 | +from cratedb_mcp.settings import PERMIT_ALL_STATEMENTS |
| 9 | + |
| 10 | +logger = logging.getLogger(__name__) |
| 11 | + |
| 12 | + |
| 13 | +def sql_is_permitted(expression: str) -> bool: |
| 14 | + """ |
| 15 | + Validate the SQL expression, only permit read queries by default. |
| 16 | +
|
| 17 | + When the `CRATEDB_MCP_PERMIT_ALL_STATEMENTS` environment variable is set, |
| 18 | + allow all types of statements. |
| 19 | +
|
| 20 | + FIXME: Revisit implementation, it might be too naive or weak. |
| 21 | + Issue: https://github.com/crate/cratedb-mcp/issues/10 |
| 22 | + Question: Does SQLAlchemy provide a solid read-only mode, or any other library? |
| 23 | + """ |
| 24 | + is_dql = SqlFilter(expression=expression, permit_all=PERMIT_ALL_STATEMENTS).is_dql |
| 25 | + if is_dql is True: |
| 26 | + logger.info(f"Permitted SQL expression: {expression}") |
| 27 | + else: |
| 28 | + logger.warning(f"Denied SQL expression: {expression}") |
| 29 | + return is_dql |
| 30 | + |
| 31 | + |
| 32 | +@dataclasses.dataclass |
| 33 | +class SqlFilter: |
| 34 | + """ |
| 35 | + Manage an SQL expression for filtering purposes. |
| 36 | + Here, most importantly: Permit read-only SQL SELECT DQL statements only. |
| 37 | + """ |
| 38 | + expression: str |
| 39 | + permit_all: bool = False |
| 40 | + |
| 41 | + _parsed_cratedb: t.Any = dataclasses.field(init=False, default=None) |
| 42 | + _parsed_sqlparse: t.Any = dataclasses.field(init=False, default=None) |
| 43 | + |
| 44 | + def __post_init__(self) -> None: |
| 45 | + if self.expression: |
| 46 | + self.expression = self.expression.strip() |
| 47 | + |
| 48 | + def parse_cratedb(self): |
| 49 | + """ |
| 50 | + Parse expression using `cratedb-sqlparse` library. |
| 51 | + """ |
| 52 | + if self._parsed_cratedb is None: |
| 53 | + self._parsed_cratedb = cratedb_sqlparse.sqlparse(self.expression) |
| 54 | + return self._parsed_cratedb |
| 55 | + |
| 56 | + def parse_sqlparse(self): |
| 57 | + """ |
| 58 | + Parse expression using traditional `sqlparse` library. |
| 59 | + """ |
| 60 | + if self._parsed_sqlparse is None: |
| 61 | + self._parsed_sqlparse = sqlparse.parse(self.expression) |
| 62 | + return self._parsed_sqlparse |
| 63 | + |
| 64 | + @property |
| 65 | + def is_dql(self) -> bool: |
| 66 | + """ |
| 67 | + Whether the statement is a DQL statement, which effectively invokes read-only operations only. |
| 68 | + """ |
| 69 | + |
| 70 | + if not self.expression: |
| 71 | + return False |
| 72 | + |
| 73 | + if self.permit_all: |
| 74 | + return True |
| 75 | + |
| 76 | + # Parse the SQL statement using `cratedb-sqlparse`. |
| 77 | + parsed = self.parse_cratedb() |
| 78 | + |
| 79 | + # Reject multiple statements to prevent potential SQL injections. |
| 80 | + if len(parsed) > 1: |
| 81 | + return False |
| 82 | + |
| 83 | + # Check if the expression is valid and if it's a DQL/SELECT statement, |
| 84 | + # also trying to consider `SELECT ... INTO ...` and evasive |
| 85 | + # `SELECT * FROM users; \uff1b DROP TABLE users` statements. |
| 86 | + return self.is_select and not self.is_camouflage |
| 87 | + |
| 88 | + @property |
| 89 | + def is_select(self) -> bool: |
| 90 | + """ |
| 91 | + Whether the expression is an SQL SELECT statement. |
| 92 | + """ |
| 93 | + return self.operation == 'SELECT' |
| 94 | + |
| 95 | + @property |
| 96 | + def operation(self) -> str: |
| 97 | + """ |
| 98 | + The SQL operation: SELECT, INSERT, UPDATE, DELETE, CREATE, etc. |
| 99 | + """ |
| 100 | + return self._parsed_cratedb[0].type.upper() |
| 101 | + |
| 102 | + @property |
| 103 | + def is_camouflage(self) -> bool: |
| 104 | + """ |
| 105 | + Innocent-looking `SELECT` statements can evade filters. |
| 106 | + """ |
| 107 | + return self.is_select_into or self.is_evasive |
| 108 | + |
| 109 | + @property |
| 110 | + def is_select_into(self) -> bool: |
| 111 | + """ |
| 112 | + Use traditional `sqlparse` for catching `SELECT ... INTO ...` statements. |
| 113 | +
|
| 114 | + Note: With `cratedb-sqlparse`, we can't find the `INTO` token at all? |
| 115 | +
|
| 116 | + Examples: |
| 117 | +
|
| 118 | + SELECT * INTO foobar FROM bazqux |
| 119 | + SELECT * FROM bazqux INTO foobar |
| 120 | + """ |
| 121 | + parsed = self.parse_sqlparse() |
| 122 | + tokens = [str(item).upper() for item in parsed[0]] |
| 123 | + return "INTO" in tokens |
| 124 | + |
| 125 | + @property |
| 126 | + def is_evasive(self) -> bool: |
| 127 | + """ |
| 128 | + Use traditional `sqlparse` for catching evasive SQL statements. |
| 129 | +
|
| 130 | + A practice picked up from CodeRabbit was to reject multiple statements |
| 131 | + to prevent potential SQL injections. Is it a viable suggestion? |
| 132 | +
|
| 133 | + Note: This currently does not work with `cratedb-sqlparse`? |
| 134 | +
|
| 135 | + Examples: |
| 136 | +
|
| 137 | + SELECT * FROM users; \uff1b DROP TABLE users |
| 138 | + """ |
| 139 | + parsed = self.parse_sqlparse() |
| 140 | + return len(parsed) > 1 |
0 commit comments