# What is Shieldfy

Shieldfy is smart code security platform for developers. It helps developers build more secure applications.

## Getting Super Powers

Shieldfy allows you to quickly identify vulnerabilities in your development cycle before it hits the production environment

![](/files/-MCvyPo-_E23Abf0m31o)

## Want to get started ?

Just go to [Shieldfy](https://app.shieldfy.io/signup) and create an account. We support Github, Bitbucket and Gitlab


# How it works

Shieldfy will analyze every push / pull request to detect vulnerabilities

## 1. Create account

create a new account with just login with your github hosting provider Github, Bitbucket or Gitlab.

## 2. Connect the repository you want

Once you connect your repository Shieldfy do initial scan and put some kind of webhook to get notified automatically every time you make a change on your code.

![](/files/-MCw-bdIW2KWuWhUQpqa)

## a. Write code, commit and push 

Write your code as you are used to do and push it to your git hosting provider.

## b. The Git provider will notify Shieldfy about the push.

Your git hosting provider will send a webhook to Shieldfy to let us know about your push. Shieldfy supports all major GIT hosting (Github, Bitbucket and Gitlab).

## c. Shieldfy will clone your repository in Isolated container and start analysis

Shieldfy automatically spinning up docker container bundled with our analyzer and clone your code inside the isolated container and start the analysis. The container is removed after the analysis.

## d. Shieldfy will report back to the git provider CI with the result as well your email

You will see the result directly into your GIT CI so you can act on it, and you will get notified by email too.

![](/files/-MCw-PadoYSneqO6zktG)

## e. You can access the result any time via Shieldfy dashboard

Any time you can access your dashboard at Shieldfy, you will see all information regarding your repositories security according to your data retention plan.


# Connecting Repository

Connecting repository is easy, just  choose the organization from left and the repository name and click "Activate Shieldfy"

![](/files/-MCw0EfP8aJ6v0ihvLaP)


# Running security analysis

The security analysis runs on the following events :-

1. First full analysis when you connect your repository for the first time
2. Push event on your repository - we analyze the changes only for every push
3. Pull requests / Merge requests - we analyze the changes that will be merged.

![](/files/-MCw03HVZ_1HLjMcRUvT)


# Security Issues

We have 3 types of Security Issues

* Dependencies Vulnerabilities
* Security Warnings
* Security Vulnerabilities


# Dependencies Vulnerabilities

Shieldfy reads all of your dependencies and check them for vulnerabilities

For every dependencies you will get the information you need on the vulnerability, how you are using this dependency and the fix recommendation

![](/files/-MCw1u8offWK1loRR7PA)

You can also at any time generate a fix pullrequest to fix the vulnerability

![](/files/-MCw2AVPMhBg6NI5NfGA)


# Security Warning

Security warnings is the security issues that not directly make your website vulnerable, but if you fix it it can strengthen your security and make it harder for the hacker to exploit. 

Examples: Security configurations, Missing security headers ... etc


# Security vulnerabilities

Security vulnerabilities is the security issues inside your own code that can lead to exploitation by the hackers.

![](/files/-MCw2y2iYJlP-Ueli2_K)

In every vulnerability you will find the details you want to understand the vulnerability, and actionable information on how to fix it.