Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Add and Update #26

Merged
merged 8 commits into from
Jul 3, 2021
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at . All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
87 changes: 87 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Contributing Guidelines

When contributing to this repository, Please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When contributing to this repository, please share your proposal via a GitHub issue and our discord server.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow! Its great if we have discord . Thanks to share I will add this.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! We have a discord for the OTR community 👍🏾 feel free to join. the link is the automatic invitatio


This documentation contains a set of guidelines to help you during the contribution process.
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, **no contribution is too small.**

#### Table Of Contents

* [Code of Conduct](#code-of-conduct)
* [Submitting Contributions](#submit-contributions)
* [Find An Issue](#step-0--find-an-issue)
* [Fork The Project](#step-1--fork-the-project)
* [Branch](#step-2--branch)
* [Work on the issue assigned](#step-3--work-on-the-issue-assigned)
* [Commit](#step-4--commit)
* [Work Remotely](#step-5--work-remotely)
* [Pull Request](#step-6--pull-request)

## Code of Conduct
This project and everyone participating in it is governed by the Contributor Covenant. Make sure to read it here: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)

## Submit Contributions
Below you will find the process and workflow used to review and merge your changes.

### Step 0 : Find an issue
- Take a look at the Existing Issues or create your **own** Issues!
- Wait for the Issue to be assigned to you after which you can start working on it.
- Note : Every change in this project should/must have an associated issue.

### Step 1 : Fork the Project
- Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in `upstream` remote.
```
$ git clone https://github.com/<your-username>/ATTACK-Python-Client.git
# Navigate to the project directory.
$ cd Hacking-Scripts
$ git remote add upstream https://github.com/OTRF/ATTACK-Python-Client.git
```

- If you have already forked the project, update your copy before working.
```
$ git remote update
$ git checkout <branch-name>
$ git rebase upstream/<branch-name>
```

### Step 2 : Branch
Create a new branch. Use its name to identify the issue your addressing.
```
# It will create a new branch with name Branch_Name and switch to that branch
$ git checkout -b Branch_Name
```

### Step 3 : Work on the issue assigned
- Work on the issue(s) assigned to you.
- Add all the files/folders needed.
- After you've made changes or made your contribution to the project add changes to the branch you've just created by:
```
# To add all new files to branch Branch_Name
$ git add .
```
```
# To add only a few files to Branch_Name
$ git add <some files>
```

### Step 4 : Commit
- To commit give a descriptive message for the convenience of reviewer by:
```
# This message get associated with all files you have changed
$ git commit -m "message"
```
- **NOTE**: A PR should have only one commit. Multiple commits not allowed.

### Step 5 : Work Remotely
- Now you are ready to your work to the remote repository.
- When your work is ready and complies with the project conventions, upload your changes to your fork:

```
# To push your work to your remote repository
$ git push -u origin Branch_Name
```
- Here is how your branch will look.

### Step 6 : Pull Request
- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.
- Good Work! Your Pull Request has been submitted and will be reviewed by the moderators and merged.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ A Python module to access up to date ATT&CK content available in STIX via public

## Goals

* Provide an easy way to access and interact with up to date ATT&CK content available in STIX via public TAXII server
* Allow security analysts to quickly explore ATT&CK content and apply it in their daily operations
* Allow the integration of ATT&Ck content with other platforms to host up to date information from the framework
* Help security analysts during the transition from the ATT&CK MediaWiki API to the STIX/TAXII 2.0 API
* Provide an easy way to access and interact with up to date ATT&CK content available in STIX via public TAXII server.
* Allow security analysts to quickly explore ATT&CK content and apply it in their daily operations.
* Allow the integration of ATT&Ck content with other platforms to host up to date information from the framework.
* Help security analysts during the transition from the ATT&CK MediaWiki API to the STIX/TAXII 2.0 API.
* Learn STIX2 and TAXII Client Python libraries

## Documentation

## [https://attackcti.com](https://attackcti.com)
### [https://attackcti.com](https://attackcti.com)

## Current Status: Production/Stable

Expand All @@ -34,11 +34,14 @@ The project is currently in a Production/Stable stage, which means that the curr

### Requirements

Python 3+
Python >= 3.0
stix2 >= 2.1.0
taxii2-client >= 2.2.2
six >= 1.15.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

taxii2-client >= 2.3.0
six >= 1.16.0

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Cyb3rWard0g anything else you would like to add and change in these files ?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe other than that, it looks good! Thank you again for contributing to the project :)


### Installation

You can install it via PIP:
You can install it via pip:

```
pip install attackcti
Expand All @@ -52,6 +55,17 @@ cd ATTACK-Python-Client
pip install .
```

## Contribution

* Now that the project is more stable, It would be great to get your feedback and hopefully get more contributions to the project. Let us know if you have any features in mind. We would love to collaborate to make them happen in the project.
* Check our basic contribution guidelines and submit an issue with your ideas.
* Be concise but clear when adding a title and description to your feature proposal.
* One pull request per issue.
* Select one or more label when you submit an issue.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

labels

* Make sure you are in the correct branch [Master].
* Try to avoid sizeable changes unless warranted.
* Be patient and polite as the project is still relatively small, which is why we would appreciate your help where possible and We will definetly reach to you, to see you awsome work.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Be patient and polite as the project is still relatively small, which is why we would appreciate your help where possible.


## Author

* Roberto Rodriguez [@Cyb3rWard0g](https://twitter.com/Cyb3rWard0g)
Expand Down