{"id":19873051,"url":"https://github.com/checkpointsw/showpolicypackage","last_synced_at":"2025-07-10T07:37:16.726Z","repository":{"id":28847259,"uuid":"102248445","full_name":"CheckPointSW/ShowPolicyPackage","owner":"CheckPointSW","description":"Check Point ShowPolicyPackage tool shows the content of a policy package (layers, rulebase, objects) over HTML pages.","archived":false,"fork":false,"pushed_at":"2024-11-13T11:54:56.000Z","size":308,"stargazers_count":30,"open_issues_count":1,"forks_count":13,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-05-02T09:49:01.616Z","etag":null,"topics":["management-api"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CheckPointSW.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-09-03T07:32:56.000Z","updated_at":"2024-11-13T11:55:00.000Z","dependencies_parsed_at":"2024-10-27T09:20:34.291Z","dependency_job_id":"a3cf25ff-f213-49a3-a5ba-c72fe9880b94","html_url":"https://github.com/CheckPointSW/ShowPolicyPackage","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/CheckPointSW/ShowPolicyPackage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2FShowPolicyPackage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2FShowPolicyPackage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2FShowPolicyPackage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2FShowPolicyPackage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CheckPointSW","download_url":"https://codeload.github.com/CheckPointSW/ShowPolicyPackage/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2FShowPolicyPackage/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264545339,"owners_count":23625422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["management-api"],"created_at":"2024-11-12T16:17:39.581Z","updated_at":"2025-07-10T07:37:16.704Z","avatar_url":"https://github.com/CheckPointSW.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ShowPolicyPackage\n \n## Background\nThe Show Package Tool allows the Security Policy as well as objects in the objects database to be exported \ninto a readable format. This exported information represents a snapshot of the database.\n\n## Output\nThe tool generates a compressed file (.tar.gz) containing the following files:\n\n• HTML files - The objects and rules presented as html files. The \"index.html\" acts as a starting point and  \nlists all the available items to display.\n\t\n• JSON files - The objects and rules exported as multiple JSON files.\n\t\n• Log file (e.g. show_package-yyyy-mm-dd_HH-MM-ss.elg) - A log file containing debug information.\n\n## Usage Syntax\n\nTo use the tool you have to obtain `web_api_show_package-jar-with-dependencies.jar` artifact by downloading it from the **Releases** tab or by building it from the sources (see **Build Instructions** below).\n\nThen you run:\n\n```java -jar web_api_show_package-jar-with-dependencies.jar [-m server-ip] [-d domain-name] [-k package-name] [-v] [-c] [--show-rule-uid] [-n port-number] [-o path] [--show-membership (true|false)] [--dereference-group-members (true|false)]```\n      \nWhere:\n\n• [-m server-ip] (Optional): Management server ip address. Default value is 127.0.0.1.\n\n• [-u username] (Optional): Management administrator user name.\n\n• [-p password] (Optional): Management administrator password.\n\n• [--api-key] (Optional): Management administrator API key.\n\n• [--cloud-mgmt-id] (Optional): Smart-1 Cloud management UID.\n\n• [-d domain-name] (Optional): The name or uid of the Security Management Server domain.  \nWhen running the command on a Multi domain server the default domain is the \"MDS\".\n\n• [-v] (Optional): List the existing policy packages.\n\n• [-c] (Optional): Retrieve access policy rules' hit count.\n\n• [--show-rule-uid] (Optional): Show each rule's UID.\n\n• [-k package-name] (Optional): The package name or the uid of the policy package to show.  \nWhen a package-name is not provided, the tool will provide details on all the policy-packages  \nthat are being used (the ones that were installed on the security gateways).\n\n• [-n port-number] (Optional): The port of WebAPI server on Security Management Server.  \nDefault value is 443.\n\n• [-o path] (Optional): The output path. The location in which to save the resulting .tar.gz file.  \nThe parameter can also be the full path (including the .tar.gz filename).   \nThe default is the current directory.  \n\n• [--show-membership (true|false)] (Optional): Whether to calculate groups membership for the objects (\"groups\" field).\nThis flag is supported from R80.10 Jumbo HF take 70\n        \n• [--dereference-group-members (true|false)] (Optional): Whether to dereference group members.\nThis flag is supported from R80.10 Jumbo HF take 70\n\n• [--query-limit limit] (Optional): The objects query limit. No more than that many results will be returned.  \nMinimum value is 1, maximum value is 500. Default value is 10.\n\n• [--show-access-policy (true|false)] (Optional): Indicates whether to show access policy as part of policy package. Default value is True.\n\n• [--show-threat-policy (true|false)] (Optional): Indicates whether to show threat policy as part of policy package. Default value is True.\n\n• [--show-nat-policy (true|false)] (Optional): Indicates whether to show nat policy as part of policy package. Default value is True.\n\n• [--show-https-policy (true|false)] (Optional): Indicates whether to show https policy as part of policy package. Default value is True.\n\nUse \"--version\" option to print the version of the tool\n\nUse \"-h\" option in order to see the full list of options to configure the tool  \n\n## Examples\n• Running the tool on a Security Management server:  \n`java -jar web_api_show_package-jar-with-dependencies.jar`  \n\n• Running the tool on a Security Management server for a specific policy package:  \n`java -jar web_api_show_package-jar-with-dependencies.jar -k \u003cPACKAGE NAME\u003e`  \n\n• Running the tool on a Multi-Domain Server for specific domain and a specific policy package:  \n`java -jar web_api_show_package-jar-with-dependencies.jar -k \u003cPACKAGE NAME\u003e -d \u003cDOMAIN NAME\u003e`  \n  \n• Running the tool on a side server to export the policy packages from the Security Management server running on 198.51.100.5:  \n`java -jar web_api_show_package-jar-with-dependencies.jar -m 198.51.100.5 -v`\n\n• Running the tool on a side server to export the policy packages from Smart-1 Cloud over proxy server 192.168.10.10 port 3128:\n\n`java -jar web_api_show_package-jar-with-dependencies.jar -m MyTenant.maas.checkpoint.com --cloud-mgmt-id \u003cUUID\u003e --api-key \u003cAPI_KEY\u003e -x 192.168.10.10:3128`\n\n## Build Instructions\n\nFollow the steps below in order to build \"Show Package Tool\" project:   \n  \n1. build 'java sdk':   \n* download directory `cp-mgmt-api-java-sdk-master` from [Check Point API Java SDK](https://github.com/CheckPoint-APIs-Team/cp-mgmt-api-java-sdk)   \n* run `mvn clean install`.    \nThe target directory `cp-mgmt-api-java-sdk-master\\mgmt_api_lib\\target` should now contain `mgmt_api_library_java-1.0.1.jar`.   \n2. build \"Show Package Tool\":      \n* download the 'show package tool' folder .     \n* run `mvn clean install`.   \nThe target directory should now contain `web_api_show_package-jar-with-dependencies.jar`.     \n   \nFollow the steps below in order to use the new jar of \"Show Package Tool\" on your Check Point Security Management server:    \n  \n(BEFORE: Please backup all the original files to have an ability to rollback)  \n  \n1. Copy `web_api_show_package-jar-with-dependencies.jar` from `target` directory into `$MDS_FWDIR/api/samples/lib`   \n2. Copy `web_api_show_package.sh` from `script` directory into `$MDS_FWDIR/scripts/` \n\n## Note\n\nThis tool is already installed on Check Point Security Management servers running version R80 with Jumbo-HF and above.\n\nThe Check Point Management Server also has a wrapper script so the tool can be run as `$MDS_FWDIR/scripts/web_api_show_package.sh` which in turn executes `java -jar $MDS_FWDIR/api/samples/lib/web_api_show_package-jar-with-dependencies.jar` \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckpointsw%2Fshowpolicypackage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckpointsw%2Fshowpolicypackage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckpointsw%2Fshowpolicypackage/lists"}