[GitHub] [apisix] Baoyuantop commented on a change in pull request #5727: feat: add CSRF plugin
Baoyuantop commented on a change in pull request #5727:
URL: https://github.com/apache/apisix/pull/5727#discussion_r786428808
##
File path: apisix/plugins/csrf.lua
##
@@ -0,0 +1,161 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local core = require("apisix.core")
+local resty_sha256 = require("resty.sha256")
+local str = require("resty.string")
+local ngx = ngx
+local ngx_encode_base64 = ngx.encode_base64
+local ngx_decode_base64 = ngx.decode_base64
+local ngx_time = ngx.time
+local cookie_time = ngx.cookie_time
+local math = math
+
+
+local schema = {
+type = "object",
+properties = {
+key = {
+description = "use to generate csrf token",
+type = "string",
+},
+expires = {
+description = "expires time(s) for csrf token",
+type = "integer",
+default = 7200
+},
+name = {
+description = "the csrf token name",
+type = "string",
+default = "apisix-csrf-token"
+}
+},
+required = {"key"}
+}
+
+
+local _M = {
+version = 0.1,
+priority = 2980,
+name = "csrf",
+schema = schema,
+}
+
+
+function _M.check_schema(conf)
+return core.schema.check(schema, conf)
+end
+
+
+local function gen_sign(random, expires, key)
+local sha256 = resty_sha256:new()
+
+local sign = "{expires:" .. expires .. ",random:" .. random .. ",key:" ..
key .. "}"
+
+sha256:update(sign)
+local digest = sha256:final()
+
+return str.to_hex(digest)
+end
+
+
+local function gen_csrf_token(conf)
+local random = math.random()
+local sign = gen_sign(random, conf.expires, conf.key)
+
+local token = {
+random = random,
+expires = conf.expires,
+sign = sign,
+}
+
+local cookie = ngx_encode_base64(core.json.encode(token))
+return cookie
+end
+
+
+local function check_csrf_token(conf, ctx, token)
+local token_str = ngx_decode_base64(token)
+if token_str == nil then
+core.log.error("csrf token base64 decode error")
+return false
+end
+
+local token_table, err = core.json.decode(token_str)
+if err then
+core.log.error("decode token error: ", err)
+return false
+end
+
+local random = token_table["random"]
+if not random then
+core.log.error("no random in token")
+return false
+end
+
+local expires = token_table["expires"]
+if not expires then
+core.log.error("no expires in token")
+return false
+end
Review comment:
Done @bisakhmondal. https://github.com/apache/apisix/issues/6141
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] Baoyuantop commented on a change in pull request #5727: feat: add CSRF plugin
Baoyuantop commented on a change in pull request #5727:
URL: https://github.com/apache/apisix/pull/5727#discussion_r785641183
##
File path: apisix/plugins/csrf.lua
##
@@ -0,0 +1,161 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local core = require("apisix.core")
+local resty_sha256 = require("resty.sha256")
+local str = require("resty.string")
+local ngx = ngx
+local ngx_encode_base64 = ngx.encode_base64
+local ngx_decode_base64 = ngx.decode_base64
+local ngx_time = ngx.time
+local cookie_time = ngx.cookie_time
+local math = math
+
+
+local schema = {
+type = "object",
+properties = {
+key = {
+description = "use to generate csrf token",
+type = "string",
+},
+expires = {
+description = "expires time(s) for csrf token",
+type = "integer",
+default = 7200
+},
+name = {
+description = "the csrf token name",
+type = "string",
+default = "apisix-csrf-token"
+}
+},
+required = {"key"}
+}
+
+
+local _M = {
+version = 0.1,
+priority = 2980,
+name = "csrf",
+schema = schema,
+}
+
+
+function _M.check_schema(conf)
+return core.schema.check(schema, conf)
+end
+
+
+local function gen_sign(random, expires, key)
+local sha256 = resty_sha256:new()
+
+local sign = "{expires:" .. expires .. ",random:" .. random .. ",key:" ..
key .. "}"
+
+sha256:update(sign)
+local digest = sha256:final()
+
+return str.to_hex(digest)
+end
+
+
+local function gen_csrf_token(conf)
+local random = math.random()
+local sign = gen_sign(random, conf.expires, conf.key)
+
+local token = {
+random = random,
+expires = conf.expires,
+sign = sign,
+}
+
+local cookie = ngx_encode_base64(core.json.encode(token))
+return cookie
+end
+
+
+local function check_csrf_token(conf, ctx, token)
+local token_str = ngx_decode_base64(token)
+if token_str == nil then
+core.log.error("csrf token base64 decode error")
+return false
+end
+
+local token_table, err = core.json.decode(token_str)
+if err then
+core.log.error("decode token error: ", err)
+return false
+end
+
+local random = token_table["random"]
+if not random then
+core.log.error("no random in token")
+return false
+end
+
+local expires = token_table["expires"]
+if not expires then
+core.log.error("no expires in token")
+return false
+end
Review comment:
Hi @bisakhmondal, I would prefer a separate PR to solve this problem,
this PR is already a bit big.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] Baoyuantop commented on a change in pull request #5727: feat: add CSRF plugin
Baoyuantop commented on a change in pull request #5727:
URL: https://github.com/apache/apisix/pull/5727#discussion_r785424673
##
File path: apisix/plugins/csrf.lua
##
@@ -0,0 +1,161 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local core = require("apisix.core")
+local resty_sha256 = require("resty.sha256")
+local str = require("resty.string")
+local ngx = ngx
+local ngx_encode_base64 = ngx.encode_base64
+local ngx_decode_base64 = ngx.decode_base64
+local ngx_time = ngx.time
+local cookie_time = ngx.cookie_time
Review comment:
Agree
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] Baoyuantop commented on a change in pull request #5727: feat: add CSRF plugin
Baoyuantop commented on a change in pull request #5727:
URL: https://github.com/apache/apisix/pull/5727#discussion_r777898436
##
File path: apisix/plugins/csrf.lua
##
@@ -0,0 +1,168 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local core = require("apisix.core")
+local resty_sha256 = require("resty.sha256")
+local ck = require("resty.cookie")
+local ngx = ngx
+local plugin_name = "csrf"
+local ngx_encode_base64 = ngx.encode_base64
+local ngx_decode_base64 = ngx.decode_base64
+local timer = ngx.time
+local cookie_time = ngx.cookie_time
+local math = math
+
+local schema = {
+type = "object",
+properties = {
+ key = {
+description = "use to generate csrf token",
+type = "string",
+ },
+ expires = {
+description = "expires time for csrf token",
+type = "integer",
+default = 7200
+ },
+ name = {
+description = "the csrf token name",
+type = "string",
+default = "apisix_csrf_token"
+ }
+},
+required = {"key"}
+}
+
+local _M = {
+version = 0.1,
+priority = 3500,
+name = plugin_name,
+schema = schema,
+}
+
+function _M.check_schema(conf)
+return core.schema.check(schema, conf)
+end
+
+
+local function gen_sign(random, expires, key)
+local sha256 = resty_sha256:new()
+
+local sign = {
+ random = random,
+ expires = expires,
+ key = key,
+}
+
+sha256:update(core.json.encode(sign))
+local digest = sha256:final()
+
+return ngx_encode_base64(digest)
+end
+
+
+local function gen_csrf_token(conf)
+local random = math.random();
+local sign = gen_sign(random, conf.expires, conf.key)
+
+local token = {
+ random = random,
+ expires = conf.expires,
+ sign = sign,
+}
+
+local cookie = ngx_encode_base64(core.json.encode(token))
+return cookie
+end
+
+
+local function check_csrf_token(conf, ctx, token)
+local _token = ngx_decode_base64(token)
+local _token_table, err = core.json.decode(_token)
+if err then
+ core.log.error("decode token error: ", err)
+ return false
+end
+
+local random = _token_table["random"]
+if not random then
+ core.log.warn("no random in token")
+ return false
+end
+
+local expires = _token_table["expires"]
+if not expires then
+ core.log.warn("no expires in token")
+ return false
+end
+
+local sign = gen_sign(random, expires, conf.key)
+if _token_table["sign"] ~= sign then
+ return false
+end
+
+return true
+end
+
+
+function _M.access(conf, ctx)
+local method = ctx.var.request_method
+if method == 'GET' then
Review comment:
This type of request has no side effects and does not need to accept
protection, but of course, I will add the corresponding instructions in the
documentation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] Baoyuantop commented on a change in pull request #5727: feat: add CSRF plugin
Baoyuantop commented on a change in pull request #5727:
URL: https://github.com/apache/apisix/pull/5727#discussion_r776914120
##
File path: apisix/plugins/csrf.lua
##
@@ -0,0 +1,168 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local core = require("apisix.core")
+local resty_sha256 = require("resty.sha256")
+local ck = require("resty.cookie")
+local ngx = ngx
+local plugin_name = "csrf"
+local ngx_encode_base64 = ngx.encode_base64
+local ngx_decode_base64 = ngx.decode_base64
+local timer = ngx.time
+local cookie_time = ngx.cookie_time
+local math = math
+
+local schema = {
+type = "object",
+properties = {
+ key = {
+description = "use to generate csrf token",
+type = "string",
+ },
+ expires = {
+description = "expires time for csrf token",
+type = "integer",
+default = 7200
+ },
+ name = {
+description = "the csrf token name",
+type = "string",
+default = "apisix_csrf_token"
+ }
+},
+required = {"key"}
+}
+
+local _M = {
+version = 0.1,
+priority = 3500,
+name = plugin_name,
+schema = schema,
+}
+
+function _M.check_schema(conf)
+return core.schema.check(schema, conf)
+end
+
+
+local function gen_sign(random, expires, key)
+local sha256 = resty_sha256:new()
+
+local sign = {
+ random = random,
+ expires = expires,
+ key = key,
+}
+
+sha256:update(core.json.encode(sign))
+local digest = sha256:final()
+
+return ngx_encode_base64(digest)
+end
+
+
+local function gen_csrf_token(conf)
+local random = math.random();
+local sign = gen_sign(random, conf.expires, conf.key)
+
+local token = {
+ random = random,
+ expires = conf.expires,
+ sign = sign,
+}
+
+local cookie = ngx_encode_base64(core.json.encode(token))
+return cookie
+end
+
+
+local function check_csrf_token(conf, ctx, token)
+local _token = ngx_decode_base64(token)
+local _token_table, err = core.json.decode(_token)
+if err then
+ core.log.error("decode token error: ", err)
+ return false
+end
+
+local random = _token_table["random"]
+if not random then
+ core.log.warn("no random in token")
+ return false
+end
+
+local expires = _token_table["expires"]
+if not expires then
+ core.log.warn("no expires in token")
+ return false
+end
+
+local sign = gen_sign(random, expires, conf.key)
+if _token_table["sign"] ~= sign then
+ return false
+end
+
+return true
+end
+
+
+function _M.access(conf, ctx)
+local method = ctx.var.request_method
+if method == 'GET' then
+ return
+end
+
+local token = core.request.header(ctx, conf.name)
+if not token then
+ return 401, {error_msg = "no csrf token in request header"}
+end
+
+local cookie, err = ck:new()
+if not cookie then
+ return nil, err
+end
+
+local field_cookie, err = cookie:get(conf.name)
+if not field_cookie then
+ return 401, {error_msg = "no csrf cookie"}
+end
+
+if err then
+ core.log.error(err)
+ return 400, {error_msg = "read csrf cookie failed"}
+end
+
+if token ~= field_cookie then
+ return 401, {error_msg = "csrf token mismatch"}
+end
+
+local result = check_csrf_token(conf, ctx, token)
+if not result then
+ return 401, {error_msg = "Failed to verify the csrf token signature"}
+end
+end
+
+
+function _M.header_filter(conf, ctx)
+local method = ctx.var.request_method
+if method == 'GET' then
Review comment:
OPTIONS has been added to take into account cross-domain requests.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] Baoyuantop commented on a change in pull request #5727: feat: add CSRF plugin
Baoyuantop commented on a change in pull request #5727:
URL: https://github.com/apache/apisix/pull/5727#discussion_r774296400
##
File path: apisix/plugins/csrf.lua
##
@@ -0,0 +1,168 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local core = require("apisix.core")
+local resty_sha256 = require("resty.sha256")
+local ck = require("resty.cookie")
+local ngx = ngx
+local plugin_name = "csrf"
+local ngx_encode_base64 = ngx.encode_base64
+local ngx_decode_base64 = ngx.decode_base64
+local timer = ngx.time
+local cookie_time = ngx.cookie_time
+local math = math
+
+local schema = {
+type = "object",
+properties = {
+ key = {
+description = "use to generate csrf token",
+type = "string",
+ },
+ expires = {
+description = "expires time for csrf token",
+type = "integer",
+default = 7200
+ },
+ name = {
+description = "the csrf token name",
+type = "string",
+default = "apisix_csrf_token"
+ }
+},
+required = {"key"}
+}
+
+local _M = {
+version = 0.1,
+priority = 3500,
+name = plugin_name,
+schema = schema,
+}
+
+function _M.check_schema(conf)
+return core.schema.check(schema, conf)
+end
+
+
+local function gen_sign(random, expires, key)
+local sha256 = resty_sha256:new()
+
+local sign = {
+ random = random,
+ expires = expires,
+ key = key,
+}
+
+sha256:update(core.json.encode(sign))
+local digest = sha256:final()
+
+return ngx_encode_base64(digest)
+end
+
+
+local function gen_csrf_token(conf)
+local random = math.random();
+local sign = gen_sign(random, conf.expires, conf.key)
+
+local token = {
+ random = random,
+ expires = conf.expires,
+ sign = sign,
+}
+
+local cookie = ngx_encode_base64(core.json.encode(token))
+return cookie
+end
+
+
+local function check_csrf_token(conf, ctx, token)
+local _token = ngx_decode_base64(token)
+local _token_table, err = core.json.decode(_token)
+if err then
+ core.log.error("decode token error: ", err)
+ return false
+end
+
+local random = _token_table["random"]
+if not random then
+ core.log.warn("no random in token")
+ return false
+end
+
+local expires = _token_table["expires"]
+if not expires then
+ core.log.warn("no expires in token")
+ return false
+end
+
+local sign = gen_sign(random, expires, conf.key)
+if _token_table["sign"] ~= sign then
+ return false
+end
+
+return true
+end
+
+
+function _M.access(conf, ctx)
+local method = ctx.var.request_method
+if method == 'GET' then
Review comment:
Here a port is needed for getting the csrf token, and if all of them are
blocked, the cookie may not be placed. Therefore, CORS on this port should be
configured carefully, as I will explain in the documentation.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
[GitHub] [apisix] Baoyuantop commented on a change in pull request #5727: feat: add CSRF plugin
Baoyuantop commented on a change in pull request #5727:
URL: https://github.com/apache/apisix/pull/5727#discussion_r768688847
##
File path: apisix/plugins/csrf.lua
##
@@ -0,0 +1,169 @@
+--
+-- Licensed to the Apache Software Foundation (ASF) under one or more
+-- contributor license agreements. See the NOTICE file distributed with
+-- this work for additional information regarding copyright ownership.
+-- The ASF licenses this file to You under the Apache License, Version 2.0
+-- (the "License"); you may not use this file except in compliance with
+-- the License. You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+local core = require("apisix.core")
+local ngx = ngx
+local plugin_name = "csrf"
+local ngx_encode_base64 = ngx.encode_base64
+local ngx_decode_base64 = ngx.decode_base64
+local request_method = ngx.var.request_method
+local timer = ngx.time
+local cookie_time = ngx.cookie_time
+local ck = require "resty.cookie"
+local math = math
+
+local schema = {
+type = "object",
+properties = {
+ key = {
Review comment:
It is used to encrypt the token to prevent it from being forged.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
