diff options
Diffstat (limited to 'src/rgw/rgw_lua.h')
-rw-r--r-- | src/rgw/rgw_lua.h | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/src/rgw/rgw_lua.h b/src/rgw/rgw_lua.h new file mode 100644 index 000000000..a6ebcc2d0 --- /dev/null +++ b/src/rgw/rgw_lua.h @@ -0,0 +1,67 @@ +#pragma once + +#include <string> +#include <set> +#include "rgw_lua_version.h" +#include "common/async/yield_context.h" +#include "common/dout.h" +#include "rgw_sal_fwd.h" + +class DoutPrefixProvider; +class lua_State; +class rgw_user; +class DoutPrefixProvider; +namespace rgw::sal { + class RadosStore; + class LuaManager; +} + +namespace rgw::lua { + +enum class context { + preRequest, + postRequest, + background, + getData, + putData, + none +}; + +// get context enum from string +// the expected string the same as the enum (case insensitive) +// return "none" if not matched +context to_context(const std::string& s); + +// verify a lua script +bool verify(const std::string& script, std::string& err_msg); + +// driver a lua script in a context +int write_script(const DoutPrefixProvider *dpp, rgw::sal::LuaManager* manager, const std::string& tenant, optional_yield y, context ctx, const std::string& script); + +// read the stored lua script from a context +int read_script(const DoutPrefixProvider *dpp, rgw::sal::LuaManager* manager, const std::string& tenant, optional_yield y, context ctx, std::string& script); + +// delete the stored lua script from a context +int delete_script(const DoutPrefixProvider *dpp, rgw::sal::LuaManager* manager, const std::string& tenant, optional_yield y, context ctx); + +using packages_t = std::set<std::string>; + +#ifdef WITH_RADOSGW_LUA_PACKAGES + +// add a lua package to the allowlist +int add_package(const DoutPrefixProvider *dpp, rgw::sal::Driver* driver, optional_yield y, const std::string& package_name, bool allow_compilation); + +// remove a lua package from the allowlist +int remove_package(const DoutPrefixProvider *dpp, rgw::sal::Driver* driver, optional_yield y, const std::string& package_name); + +// list lua packages in the allowlist +int list_packages(const DoutPrefixProvider *dpp, rgw::sal::Driver* driver, optional_yield y, packages_t& packages); + +// install all packages from the allowlist +// return the list of packages that failed to install and the output of the install command +int install_packages(const DoutPrefixProvider *dpp, rgw::sal::Driver* driver, + optional_yield y, const std::string& luarocks_path, + packages_t& failed_packages, std::string& output); +#endif +} + |