nokia/kong-oidc plugin raise error kong.plugins.base_plugin #13528

johndou-and-friends · 2024-08-20T11:59:58Z

johndou-and-friends
Aug 20, 2024

hi have a project that require to use oidc plugin for interacting with keycloak
i search and found this free plugin and for installing in kong i do below steps:

moving package src folder to /usr/local/share/lua/5.1/kong/plugins/
adding package to to kong.yaml config

plugins:
 - name: oidc

but when i run docker compose up this error occurred

logs

	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin/init.ljbc'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin.ljbc'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin/init.ljbc'
	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin.lua'
	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin.lua'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/luajit/share/luajit-2.1/kong/plugins/base_plugin.lua'
	no file '/usr/local/share/lua/5.1/kong/plugins/base_plugin.lua'
	no file '/usr/local/share/lua/5.1/kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/luajit/share/lua/5.1/kong/plugins/base_plugin.lua'
	no file '/usr/local/openresty/luajit/share/lua/5.1/kong/plugins/base_plugin/init.lua'
	no file '/home/kong/.luarocks/share/lua/5.1/kong/plugins/base_plugin.lua'
	no file '/home/kong/.luarocks/share/lua/5.1/kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin.so'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin.so'
	no file './kong/plugins/base_plugin.so'
	no file '/usr/local/lib/lua/5.1/kong/plugins/base_plugin.so'
	no file '/usr/local/openresty/luajit/lib/lua/5.1/kong/plugins/base_plugin.so'
	no file '/usr/local/lib/lua/5.1/loadall.so'
	no file '/home/kong/.luarocks/lib/lua/5.1/kong/plugins/base_plugin.so'
	no file '/usr/local/openresty/site/lualib/kong.so'
	no file '/usr/local/openresty/lualib/kong.so'
	no file './kong.so'
	no file '/usr/local/lib/lua/5.1/kong.so'
	no file '/usr/local/openresty/luajit/lib/lua/5.1/kong.so'
	no file '/usr/local/lib/lua/5.1/loadall.so'
	no file '/home/kong/.luarocks/lib/lua/5.1/kong.so'
stack traceback:
	[C]: in function 'require'
	/usr/local/share/lua/5.1/kong/plugins/oidc/handler.lua:1: in main chunk
	[C]: at 0x7f5bb03d7c30
	[C]: in function 'xpcall'
	/usr/local/share/lua/5.1/kong/tools/module.lua:18: in function 'load_module_if_exists'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:157: in function 'load_plugin_handler'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:263: in function 'load_plugin'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:315: in function 'load_plugin_schemas'
	/usr/local/share/lua/5.1/kong/init.lua:707: in function 'init'
	init_by_lua(nginx-kong.conf:40):3: in main chunk
stack traceback:
	[C]: in function 'error'
	/usr/local/share/lua/5.1/kong/tools/module.lua:29: in function 'load_module_if_exists'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:157: in function 'load_plugin_handler'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:263: in function 'load_plugin'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:315: in function 'load_plugin_schemas'
	/usr/local/share/lua/5.1/kong/init.lua:707: in function 'init'
	init_by_lua(nginx-kong.conf:40):3: in main chunk
nginx: [error] init_by_lua error: /usr/local/share/lua/5.1/kong/tools/module.lua:29: error loading module 'kong.plugins.oidc.handler':
/usr/local/share/lua/5.1/kong/plugins/oidc/handler.lua:1: module 'kong.plugins.base_plugin' not found:No LuaRocks module found for kong.plugins.base_plugin
	no field package.preload['kong.plugins.base_plugin']
	no file './kong/plugins/base_plugin.lua'
	no file './kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin.ljbc'
	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin/init.ljbc'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin.ljbc'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin/init.ljbc'
	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin.lua'
	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin.lua'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/luajit/share/luajit-2.1/kong/plugins/base_plugin.lua'
	no file '/usr/local/share/lua/5.1/kong/plugins/base_plugin.lua'
	no file '/usr/local/share/lua/5.1/kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/luajit/share/lua/5.1/kong/plugins/base_plugin.lua'
	no file '/usr/local/openresty/luajit/share/lua/5.1/kong/plugins/base_plugin/init.lua'
	no file '/home/kong/.luarocks/share/lua/5.1/kong/plugins/base_plugin.lua'
	no file '/home/kong/.luarocks/share/lua/5.1/kong/plugins/base_plugin/init.lua'
	no file '/usr/local/openresty/site/lualib/kong/plugins/base_plugin.so'
	no file '/usr/local/openresty/lualib/kong/plugins/base_plugin.so'
	no file './kong/plugins/base_plugin.so'
	no file '/usr/local/lib/lua/5.1/kong/plugins/base_plugin.so'
	no file '/usr/local/openresty/luajit/lib/lua/5.1/kong/plugins/base_plugin.so'
	no file '/usr/local/lib/lua/5.1/loadall.so'
	no file '/home/kong/.luarocks/lib/lua/5.1/kong/plugins/base_plugin.so'
	no file '/usr/local/openresty/site/lualib/kong.so'
	no file '/usr/local/openresty/lualib/kong.so'
	no file './kong.so'
	no file '/usr/local/lib/lua/5.1/kong.so'
	no file '/usr/local/openresty/luajit/lib/lua/5.1/kong.so'
	no file '/usr/local/lib/lua/5.1/loadall.so'
	no file '/home/kong/.luarocks/lib/lua/5.1/kong.so'
stack traceback:
	[C]: in function 'require'
	/usr/local/share/lua/5.1/kong/plugins/oidc/handler.lua:1: in main chunk
	[C]: at 0x7f5bb03d7c30
	[C]: in function 'xpcall'
	/usr/local/share/lua/5.1/kong/tools/module.lua:18: in function 'load_module_if_exists'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:157: in function 'load_plugin_handler'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:263: in function 'load_plugin'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:315: in function 'load_plugin_schemas'
	/usr/local/share/lua/5.1/kong/init.lua:707: in function 'init'
	init_by_lua(nginx-kong.conf:40):3: in main chunk
stack traceback:
	[C]: in function 'error'
	/usr/local/share/lua/5.1/kong/tools/module.lua:29: in function 'load_module_if_exists'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:157: in function 'load_plugin_handler'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:263: in function 'load_plugin'
	/usr/local/share/lua/5.1/kong/db/dao/plugins.lua:315: in function 'load_plugin_schemas'
	/usr/local/share/lua/5.1/kong/init.lua:707: in function 'init'
	init_by_lua(nginx-kong.conf:40):3: in main chunk
      ```

how can i fix this problem ? can i use another free open source package with same  purpose?

Answered by nowNick

Aug 26, 2024

Hi @johndou-and-friends !

Thank you for sending this question. I'm afraid the free plugin you're trying to use is not maintained anymore. The last commit on that repo seems to be from 5 years ago.

The error you see is Kong trying to load a module called: base_plugin in this line: https://github.com/nokia/kong-oidc/blob/25104595cfedb341bda00003d792e5824943615c/kong/plugins/oidc/handler.lua#L1

However Kong is not supporting custom plugins with Base Plugin approach anymore:
https://docs.konghq.com/gateway/latest/plugin-development/custom-logic/#migrating-from-baseplugin-module

What I think you could do is:

Try to start an older version of Kong and try this plugin - but please be aware that…

View full answer

nowNick · 2024-08-26T07:45:24Z

nowNick
Aug 26, 2024
Collaborator

Hi @johndou-and-friends !

Thank you for sending this question. I'm afraid the free plugin you're trying to use is not maintained anymore. The last commit on that repo seems to be from 5 years ago.

The error you see is Kong trying to load a module called: base_plugin in this line: https://github.com/nokia/kong-oidc/blob/25104595cfedb341bda00003d792e5824943615c/kong/plugins/oidc/handler.lua#L1

However Kong is not supporting custom plugins with Base Plugin approach anymore:
https://docs.konghq.com/gateway/latest/plugin-development/custom-logic/#migrating-from-baseplugin-module

What I think you could do is:

Try to start an older version of Kong and try this plugin - but please be aware that a Kong version from 5 years ago is not supported anymore so I won't be able to provide much more help in this approach. Also I'm not sure to for what Kong version this plugin was written for. You'd have to mix-and-match.
Another solution might be to fork that plugin and try to follow the migration steps from base_plugin as described on that documentation page.

Other than that nothing else comes to my mind apart from upgrading to enterprise edition.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nokia/kong-oidc plugin raise error kong.plugins.base_plugin #13528

{{title}}

Replies: 1 comment

{{title}}

Select a reply

nokia/kong-oidc plugin raise error kong.plugins.base_plugin #13528

johndou-and-friends Aug 20, 2024

Replies: 1 comment

nowNick Aug 26, 2024 Collaborator

johndou-and-friends
Aug 20, 2024

nowNick
Aug 26, 2024
Collaborator