{"id":13751490,"url":"https://github.com/docbleach/DocBleach","last_synced_at":"2025-05-09T18:31:27.353Z","repository":{"id":37458055,"uuid":"86607520","full_name":"docbleach/DocBleach","owner":"docbleach","description":":shower: Sanitising your documents, one threat at a time. — Content Disarm \u0026 Reconstruction Software","archived":true,"fork":false,"pushed_at":"2023-09-18T08:12:53.000Z","size":394,"stargazers_count":148,"open_issues_count":42,"forks_count":34,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-11-16T04:31:35.398Z","etag":null,"topics":["content-disarm-reconstruct","java","office","pdf","security","security-tools","threat"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docbleach.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-03-29T16:55:02.000Z","updated_at":"2024-10-14T22:09:10.000Z","dependencies_parsed_at":"2023-10-21T10:56:28.881Z","dependency_job_id":null,"html_url":"https://github.com/docbleach/DocBleach","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docbleach%2FDocBleach","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docbleach%2FDocBleach/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docbleach%2FDocBleach/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docbleach%2FDocBleach/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docbleach","download_url":"https://codeload.github.com/docbleach/DocBleach/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253303024,"owners_count":21886873,"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":["content-disarm-reconstruct","java","office","pdf","security","security-tools","threat"],"created_at":"2024-08-03T09:00:46.509Z","updated_at":"2025-05-09T18:31:26.980Z","avatar_url":"https://github.com/docbleach.png","language":"Java","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"logo.png\"/\u003e\n\u003c/p\u003e\n\n\nDocBleach is an advanced Content Disarm and Reconstruction software.\nIts objective is to remove misbehaving dynamic content from your Office\nfiles, or everything that could be a threat to the safety of your computer.\n\n[![Build Status][travis_img]][travis_link]\n\nLet's assume your job involves working with files from external sources, for\ninstance reading resumes from unknown applicants. You receive for example a .doc\nfile, your anti-virus doesn't detect it as harmful, and you decide to open it\nanyway. You get infected.\nYou can use DocBleach to sanitize this document: chances are you don't get\ninfected, because the dynamic content isn't run.\n\n# Howto's\nTo build DocBleach, use Maven:\n```bash\n$ mvn clean package\n...\n[INFO] ------------------------------------------------------------------------\n[INFO] BUILD SUCCESS\n[INFO] ------------------------------------------------------------------------\n[INFO] Total time: 10.696 s\n[INFO] Finished at: 2016-12-19T17:36:10+01:00\n[INFO] Final Memory: 29M/234M\n[INFO] ------------------------------------------------------------------------\n```\nThe final jar is stored in `cli/target/docbleach.jar`.\n\n\nTo use DocBleach, you may either use the [Web Interface][webI] or run it in CLI:\n```bash\njava -jar docbleach.jar -in unsafe_document.doc -out safe_doc.doc\n```\n\nThe input file may be a relative/absolute path, an URI (think: http:// link),\nor a dash (`-`).\n\nThe output file may be a relative/absolute path, or a dash (`-`).\n\nIf a dash is given, the input will be taken from stdin, and the output will be\nsent to stdout.\n\nDocBleach's information (removed threats, errors, ...) are sent to stderr.\n\n[Advanced usage][wiki-adv-usage]\n\n## Get the sources\n\n```bash\n    git clone https://github.com/docbleach/DocBleach.git\n    cd DocBleach\n    mvn install\n    # Import it as a Maven project in your favorite IDE\n```\n\nYou've developed a new cool feature ? Fixed an annoying bug ? We'd be happy\nto hear from you !\n\n## Run the tests\nThe tests run with JUnit 5, which is perfectly integrated in Maven.\nTo run tests, just run `mvn test`. You should get something similar to this:\n\n```\n[INFO] Scanning for projects...\n...\n-------------------------------------------------------\n T E S T S\n-------------------------------------------------------\nDec 19, 2016 5:33:54 PM org.junit.platform.launcher.core.ServiceLoaderTestEngineRegistry loadTestEngines\nINFO: Discovered TestEngines with IDs: [junit-jupiter]\nRunning org.docbleach.bleach.PdfBleachTest\nTests run: 8, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.246 sec - in org.docbleach.bleach.PdfBleachTest\nRunning org.docbleach.bleach.OLE2BleachTest\n\nResults :\n\nTests run: 13, Failures: 0, Errors: 0, Skipped: 0\n\n[INFO] ------------------------------------------------------------------------\n[INFO] BUILD SUCCESS\n[INFO] ------------------------------------------------------------------------\n[INFO] Total time: 3.252 s\n[INFO] Finished at: 2016-12-19T17:33:55+01:00\n[INFO] Final Memory: 19M/211M\n[INFO] ------------------------------------------------------------------------\n```\n\nBUILD SUCCESS confirms that all the tests were run successfuly.\n\n\n# Related links\n\n * [:wrench: How to Contribute][contribute]\n * [:beetle: Reporting bugs][issues]\n * [:gem: Download latest version][release-page]\n * [:mag_right: Wiki][wiki]\n\n# Releases\nThe releases are available as Windows executables that don't depend on Java, thanks\nto the Excelsior Jet technology.\n\n[![](https://i.imgur.com/vBE9rqk.png)](https://www.excelsiorjet.com/)\n\n## License\n\nSee [LICENSE][license].\n\n\n# Project Status\n\nDon't expect the code base to change everyday, but feel free to contribute: new ideas are more than\nwelcome,  and threats evolve - so should we.\n\nSome things would be awesome, though:\n- Adding a way to configure bleaches\n- Write tests!\n- Writing more content to show and explain how the sanitation process works, why it works.\n- Adding more stats!\n\n\n\n[release-page]: https://github.com/docbleach/docbleach/releases\n[webI]: https://github.com/docbleach/DocBleach-Web\n[travis_img]: https://api.travis-ci.org/docbleach/DocBleach.svg?branch=master\n[travis_link]: https://travis-ci.org/docbleach/DocBleach\n[issues]: https://github.com/docbleach/DocBleach/issues\n[contribute]: https://github.com/docbleach/DocBleach/blob/master/CONTRIBUTING.md\n[license]: https://github.com/docbleach/DocBleach/blob/master/LICENSE\n[wiki]: https://github.com/docbleach/DocBleach/wiki\n[wiki-adv-usage]: https://github.com/docbleach/DocBleach/wiki/Advanced-usage\n","funding_links":[],"categories":["Endpoint","Analysis Tools"],"sub_categories":["Content Disarm \u0026 Reconstruct"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocbleach%2FDocBleach","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocbleach%2FDocBleach","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocbleach%2FDocBleach/lists"}