Update markdowns explaining the project
CONTRIBUTOR_AGREEMENT.md and README.md
This commit is contained in:
jerlendds
65
.github/CONTRIBUTOR_AGREEMENT.md
vendored
Normal file
65
.github/CONTRIBUTOR_AGREEMENT.md
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
# OSINTBuddy Contributor Agreement
|
||||
|
||||
This is a reference copy of the terms of the OSINTBuddy Contributor Agreement. To actually complete and submit an OCA, please sign up and go to the [OSINTBuddy forum](https://forum.osintbuddy.com/t/osintbuddy-contributor-agreement/23).
|
||||
|
||||
Thank you for your interest in OSINTBuddy. In order for You (as defined below) to make intellectual property Contributions (as defined below) now or in the future to any of the OSINTBuddy projects, You must agree to this OSINTBuddy Contributor Agreement ("OCA"). If You have any questions about this agreement, licensing, or anything related to intellectual property at OSINTBuddy, please send an email to [oss@osintbuddy.com](mailto:oss@osintbuddy.com).
|
||||
|
||||
Please read this OCA carefully before accepting its terms. By accepting the OCA, You are agreeing to be bound by its terms. If You want to accept this OCA, complete the form completely, print a copy for Your records, and when ready, press the “Accept” button at the end of this form.
|
||||
|
||||
As used in this OCA:
|
||||
|
||||
- **(i)** “You" (or "Your") shall mean the entity that is making this Agreement with the OSINTBuddy project;
|
||||
|
||||
- **(ii)** "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is submitted by You to OSINTBuddy for inclusion in, or documentation of, any of the OSINTBuddy projects; and
|
||||
|
||||
- **(iii)** “Submit” (or “Submitted”) means any form of communication sent to OSINTBuddy (e.g. the content You post on electronic mailing lists, forums, content management systems, source code control systems, code review systems, issue tracking systems, etc. that are used by OSINTBuddy).
|
||||
|
||||
This agreement applies to all Contributions You Submit.
|
||||
|
||||
This OCA, and the license(s) associated with the particular OSINTBuddy projects You are contributing to, provides a license to Your Contributions to OSINTBuddy and downstream consumers, but You still own Your Contributions, and except for the licenses provided for in this OCA, You reserve all right, title and interest in Your Contributions. In addition to the above, You grant a non-exclusive, worldwide, perpetual, royalty-free license of all necessary rights under Your copyright in and to Your Contributions (the “Specification Grant”):
|
||||
|
||||
- **(a)** for OSINTBuddy (and its contributors solely as a part of OSINTBuddy projects) to create, reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense specifications subject to the terms of the then-current OSINTBuddy projects, based on or derived from the Specification Content (as defined below) and
|
||||
|
||||
- **(b)** for recipients of such specifications to create, reproduce, and distribute implementations thereof based on the portion of Your Contributions or material derived from them in the specifications, subject to the terms of the then-current OSINTBuddy projects License(s).
|
||||
|
||||
“Specification Content” is the collection of interface definitions for the application or user interfaces (“Interfaces”) provided by the work to which Your Contribution was made, descriptions of the structure and semantic behavior of those Interfaces, and data formats and protocols associated with those Interfaces, all of which as are reasonably necessary to enable the development of independent implementations of those Interfaces. For the sake of clarity, Specification Content does not include implementation detail of how the OSINTBuddy project code or Your Contribution implements the Interfaces in the Specification and the Specification Grant provided above would not cover such additional material.
|
||||
|
||||
OSINTBuddy requires that each Contribution You Submit now or in the future to comply with the following commitments documented in the Developer Certificate of Origin ([DCO](https://wiki.linuxfoundation.org/dco)). To confirm that You have read and agreed to each, please click on the box beside each one.
|
||||
|
||||
---
|
||||
|
||||
```txt
|
||||
Developer Certificate of Origin
|
||||
Version 1.1
|
||||
|
||||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
Developer's Certificate of Origin 1.1
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
(a) The contribution was created in whole or in part by me and I
|
||||
have the right to submit it under the open source license
|
||||
indicated in the file; or
|
||||
|
||||
(b) The contribution is based upon previous work that, to the best
|
||||
of my knowledge, is covered under an appropriate open source
|
||||
license and I have the right under that license to submit that
|
||||
work with modifications, whether created in whole or in part
|
||||
by me, under the same open source license (unless I am
|
||||
permitted to submit under a different license), as indicated
|
||||
in the file; or
|
||||
|
||||
(c) The contribution was provided directly to me by some other
|
||||
person who certified (a), (b) or (c) and I have not modified
|
||||
it.
|
||||
|
||||
(d) I understand and agree that this project and the contribution
|
||||
are public and that a record of the contribution (including all
|
||||
personal information I submit with it, including my sign-off) is
|
||||
maintained indefinitely and may be redistributed consistent with
|
||||
this project or the open source license(s) involved.
|
||||
```
|
||||
33
README.md
33
README.md
@@ -84,21 +84,19 @@ An almost incomprehensible amount of data is created every day. And each year, f
|
||||
- Grey literature *(technical reports, preprints, patents, business documents, etc)*
|
||||
|
||||
|
||||
Some of the main hindrances to practical OSINT is the volume of information it has to deal with [(information explosion)](https://en.wikipedia.org/wiki/Information_explosion) and the issue of low quality data. With the majority of this data being unstructured, there's many challenges to analyzing it and producing actionable intelligence since most data analytics databases are designed for structured data.
|
||||
OSINT is a method of working with, assessing and ranking information — We are living in the [Information Age](https://en.wikipedia.org/wiki/Information_Age) and the volume of information OSINT research has to deal with [(information explosion)](https://en.wikipedia.org/wiki/Information_explosion) and the issue of low quality data leaves researchers drowning in poor quality info. The majority of this data is unstructured introducing many challenges to analyzing it and producing actionable intelligence since most data analytics databases are designed for structured data.
|
||||
|
||||
|
||||
We've decided to do something about it. The rapid developments in technologies such as AI and big data analytics have opened new horizons for OSINT which weren't previously available. We want our information quick and to the point, that's why we're building an open-source OSINT tool that's free. Free to use, free to modify, free to do with as you wish, and built with plain old web technologies anyone can learn. But this isn't really the project. This is a free new community. A community for OSINT enthusiast around the world and we need your help to design it, to program it, and to build it. We want to hear your suggestions, your ideas, and we're going to build it right in front of your eyes. The notion of a “needle in a haystack” is taken to the extreme on the internet. Let's build a magnet.
|
||||
We've decided to do something about it. The rapid developments in technologies such as AI and big data analytics have opened new horizons for OSINT which weren't previously available. We want our information quick and to the point, that's why we're building an open-source OSINT tool that's free. Free to use, free to modify, free to do with as you wish, and built with plain old web technologies anyone can learn. But this isn't really the project. This is a free new community. A community for OSINT enthusiasts around the world and we need your help to design it, to program it, and to build it. We want to hear your suggestions, your ideas, and we're going to build it right in front of your eyes. The notion of a “needle in a haystack” is taken to the extreme on the internet. Let's build a magnet.
|
||||
|
||||
|
||||
|
||||
### Key Features
|
||||
- Simplified data fetching from multiple sources.
|
||||
### Key Alpha Features
|
||||
- Simplified data fetching from custom sources using Python plugins.
|
||||
- Visual representation of fetched data for easy understanding.
|
||||
- A development platform that is open for contributions.
|
||||
- Plugin-based system for transforming data, check out the [osintbuddy](https://pypi.org/project/osintbuddy/) package.
|
||||
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
To start using OSINTBuddy, follow these simple installation steps:
|
||||
@@ -111,6 +109,7 @@ To start using OSINTBuddy, follow these simple installation steps:
|
||||
# git clone --depth=1 --recurse-submodules git@github.com:jerlendds/osintbuddy.git
|
||||
cd osintbuddy
|
||||
```
|
||||
|
||||
2. Install Docker
|
||||
- [Install Guide for Mac](https://docs.docker.com/desktop/install/mac-install/)
|
||||
- [Install Guide for Windows](https://docs.docker.com/desktop/install/windows-install/)
|
||||
@@ -135,7 +134,7 @@ To start using OSINTBuddy, follow these simple installation steps:
|
||||
|
||||
~~See the [trello board](https://trello.com/b/99Q70frX/) for a list of our upcoming features.~~
|
||||
|
||||
See the forum: [forum.osintbuddy.com](https://forum.osintbuddy.com), for a list of our upcoming features, potential ideas, and more (*Note: We're currently in the process of setting up the forum and moving trello issues over. We're not sure when this will be completed. For the time being you can count on dev log updates being on the forum from now on*).
|
||||
See the forum: [forum.osintbuddy.com](https://forum.osintbuddy.com), for a list of our upcoming features, to contribute feedback, ideas, and more (*Note: We're currently in the process of setting up the forum and moving trello issues over. We're not sure when this will be completed. For the time being you can count on dev log updates being on the forum from now on*).
|
||||
|
||||
|
||||
See the [open issues](https://github.com/jerlendds/osintbuddy/issues)
|
||||
@@ -146,7 +145,6 @@ for a list of requested features (and known issues).
|
||||
- [x] Website node
|
||||
- [x] Google search node
|
||||
- [x] Google cache search node
|
||||
- [x] Google dorks
|
||||
- [x] DNS node
|
||||
- [x] URL node
|
||||
- [x] IP node
|
||||
@@ -159,18 +157,17 @@ for a list of requested features (and known issues).
|
||||
- [x] Added Casdoor for auth
|
||||
- [x] Improved UI/UX
|
||||
|
||||
[] Add wizards for plugin create and custom `.env` setup
|
||||
|
||||
[] Rework plugin system to its own service
|
||||
|
||||
[] Add playwright and start reworking existing selenium based plugins
|
||||
*Coming soon*
|
||||
- [] Add wizards for plugin create and custom `.env` setup
|
||||
- [] Rework plugin system to its own service
|
||||
- [] Add playwright and start reworking existing selenium based plugins
|
||||
|
||||
For this update I recommend running bootstrap first, this sets up the new environment for containers: `./launcher bootstrap && ./launcher start`! After a 10m (up to 60m depending on internet speed) wait you'll be rewarded with a new UX, an updated plugin system now running as its own service, Casdoor managed auth for signing in/up, a new CLI tool, `ob`, for managing plugin development and the plugin server, and another CLI `./launcher` for managing the OSINTBuddy stack.
|
||||
|
||||
|
||||
## [↑](#introducing-osintbuddy)Contributing
|
||||
|
||||
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
||||
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. But if you'd like to make a significant change to this project or the `osintbuddy-plugins` project, please first [create an issue](https://github.com/jerlendds/osintbuddy/issues/new?assignees=jerlendds&labels=Type%3A+Suggestion&projects=&template=feature.md&title=%5BFEATURE+REQUEST%5D+Your_feature_request_here) or open a contributor post on the [forum](https://forum.osintbuddy.com/c/osintbuddy-contributors/11) to get feedback before spending too much time. We don't want you to invest your time on changes we are already working on.
|
||||
|
||||
1. Fork the Project
|
||||
2. Create your Feature Branch (`git checkout -b feature/add-core-feature`)
|
||||
@@ -181,9 +178,7 @@ Contributions are what make the open source community such an amazing place to l
|
||||
|
||||
## [↑](#introducing-osintbuddy)License
|
||||
|
||||
Licensed under the GNU Affero General Public License v3.0.
|
||||
|
||||
Copyright 2023 jerlendds. [GNU AGPL v3](https://choosealicense.com/licenses/apache-2.0/).
|
||||
[GNU Affero General Public License v3.0](https://choosealicense.com/licenses/apache-2.0/)
|
||||
|
||||
*Note: the [OSINTBuddy PyPi package](https://github.com/jerlendds/osintbuddy-plugins) is MIT licensed*.
|
||||
|
||||
@@ -196,8 +191,8 @@ Patched `aiogremlin` library: [jerlendds/gremlinpy](https://github.com/jerlendds
|
||||
|
||||
|
||||
## [↑](#introducing-osintbuddy)Sponsor OSINTBuddy
|
||||
Help us keep the OSINTBuddy project free and maintained forever.
|
||||
Sponsor the OSINTBuddy project for unique benefits. Learn more on the [OSINTBuddy OpenCollective project page](https://opencollective.com/openinfolabs/projects/osintbuddy#category-CONTRIBUTE)
|
||||
Help us keep the project free and maintained.
|
||||
Sponsor the OSINTBuddy project for unique benefits. Learn more on the [OSINTBuddy OpenCollective](https://opencollective.com/openinfolabs/projects/osintbuddy#category-CONTRIBUTE)
|
||||
|
||||
[](https://opencollective.com/openinfolabs/projects/osintbuddy#category-CONTRIBUTE)
|
||||
[](https://opencollective.com/openinfolabs/projects/osintbuddy#category-CONTRIBUTE)
|
||||
|
||||
Reference in New Issue
Block a user