Skip to content

Commit 13a59c6

Browse files
authored
version bump - 0.12.0 (#127)
1 parent bac8845 commit 13a59c6

File tree

3 files changed

+41
-9
lines changed

3 files changed

+41
-9
lines changed

CHANGELOG.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# Changelog
22

3+
## v0.12.0
4+
* Removed
5+
* Support for minimum Elixir version 1.4 (**POTENTIALLY BREAKING** - only applies if you relied on Elixir 1.4, 1.5+ is still supported)
6+
* Enhancements
7+
* Adds support for HEEx to XSS.Raw
8+
* Adds `--version` CLI flag
9+
* README Improvements
10+
* Umbrella App usage
11+
* Clearer installation process
12+
* Layout changes
13+
* Updated dependencies
14+
* Bug fixes
15+
* Adds to_string() to exit_on
16+
* Sets SSL opt verify_peer in version check
17+
* Reworks `-v, --verbose` printing to not use the now deprecated `Macro.to_string/2`
18+
* Misc
19+
* Allows atom values for threshold in config file
20+
* Uses SPDX ID for licenses in mixfile
21+
* Fixed typo
22+
323
## v0.11.2
424
* Enhancements
525
* Simplify `--flycheck` output to align with expected format

README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![License](https://img.shields.io/hexpm/l/sobelow.svg)](https://hex.pm/packages/sobelow)
77
[![Last Updated](https://img.shields.io/github/last-commit/nccgroup/sobelow.svg)](https://github.com/nccgroup/sobelow/commits/master)
88

9-
Sobelow is a security-focused static analysis tool for the
9+
Sobelow is a security-focused static analysis tool for Elixir & the
1010
Phoenix framework. For security researchers, it is a useful
1111
tool for getting a quick view of points-of-interest. For
1212
project maintainers, it can be used to prevent the introduction
@@ -32,23 +32,33 @@ red, medium confidence is yellow, and low confidence is green.
3232
A finding is typically marked "low confidence" if it looks
3333
like a function could be used insecurely, but it cannot
3434
reliably be determined if the function accepts user-supplied
35-
input. That is to say, if a finding is marked green, it may be
35+
input. i.e. **If a finding is marked green, it *may* be
3636
critically insecure, but it will require greater manual
37-
validation.
37+
validation.**
3838

3939
**Note:** This project is in constant development, and
4040
additional vulnerabilities will be flagged as time goes on.
4141
If you encounter a bug, or would like to request additional
4242
features or security checks, please open an issue!
4343

44+
## Table of Contents
45+
- [Installation](#installation)
46+
- [To Use](#to-use)
47+
- [Options](#options)
48+
- [Configuration Files](#configuration-files)
49+
- [False Positives](#false-positives)
50+
- [Modules](#modules)
51+
- [Umbrella Apps](#umbrella-apps)
52+
- [Updates](#updates)
53+
4454
## Installation
4555

4656
To use Sobelow, you can add it to your application's dependencies.
4757

4858
```elixir
4959
def deps do
5060
[
51-
{:sobelow, "~> 0.11", only: [:dev, :test], runtime: false}
61+
{:sobelow, "~> 0.12", only: [:dev, :test], runtime: false}
5262
]
5363
end
5464
```
@@ -63,9 +73,9 @@ the following command can be used:
6373

6474
$ mix escript.install github nccgroup/sobelow
6575

66-
## Use
76+
### To Use
6777

68-
The simplest way to scan a Phoenix project is to run the
78+
After installation, the simplest way to scan a Phoenix project is to run the
6979
following from the project root:
7080

7181
$ mix sobelow
@@ -134,6 +144,8 @@ relative to the application root.
134144
* `--skip` - Ignore findings that have been marked for skipping. See [False Positives](#false-positives)
135145
for more information.
136146

147+
* `--version` - Outputs the current version of Sobelow. This is useful for CI steps or integration with other tools like [Salus](https://github.com/coinbase/salus).
148+
137149
## Configuration Files
138150
Sobelow allows users to save frequently used options in a
139151
configuration file. For example, if you find yourself constantly

mix.exs

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ defmodule Sobelow.Mixfile do
22
use Mix.Project
33

44
@source_url "https://github.com/nccgroup/sobelow"
5-
@version "0.11.2"
5+
@version "0.12.0"
66

77
def project do
88
[
@@ -13,7 +13,7 @@ defmodule Sobelow.Mixfile do
1313
start_permanent: Mix.env() == :prod,
1414
deps: deps(),
1515
package: package(),
16-
description: "Security-focused static analysis for the Phoenix framework",
16+
description: "Security-focused static analysis for Elixir & the Phoenix framework",
1717
name: "Sobelow",
1818
homepage_url: "https://sobelow.io",
1919
docs: docs(),
@@ -36,7 +36,7 @@ defmodule Sobelow.Mixfile do
3636
defp package() do
3737
[
3838
licenses: ["Apache-2.0"],
39-
maintainers: ["Griffin Byatt"],
39+
maintainers: ["Griffin Byatt", "Holden Oullette"],
4040
links: %{
4141
"Changelog" => "#{@source_url}/blob/master/CHANGELOG.md",
4242
"GitHub" => @source_url

0 commit comments

Comments
 (0)