-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathREADME.Rmd
90 lines (62 loc) · 2.58 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
output: rmarkdown::github_document
---
```{r message=FALSE, warning=FALSE, error=FALSE, include=FALSE}
options(width=120)
```
# rOpenSci Unconf 18 Project : ropsec
<!-- badges: start -->
[](https://github.com/ropenscilabs/ropsec/actions)
<!-- badges: end -->
Personal Workstation Safety Checks and Utilities
<img src="man/figures/Loose_lips_might_sink_ships.jpg" style="width: 50%; height: 50%"/>
## What's Inside The Tin
The following functions are implemented:
- [`sign_commits_with_key()`](#sign-commits) [](https://www.tidyverse.org/lifecycle/)
- [`store_public_key()`](#sign-commits) [](https://www.tidyverse.org/lifecycle/)
- [`summarize_system_checks()`](#lightweight-system-checks) [](https://www.tidyverse.org/lifecycle/)
- [`full_on_audit()`](#audit) [](https://www.tidyverse.org/lifecycle/)
## Installation
```{r eval=FALSE}
devtools::install_github("ropenscilabs/ropsec")
```
To have vignettes available locally:
```{r eval=FALSE}
devtools::install_github("ropenscilabs/ropsec", build_vignettes = TRUE)
```
## Usage
```{r eval=FALSE}
library(ropsec)
```
### Sign commits with GPG key
For details see [`vignette("sign-commits", "ropsec")`](https://ropenscilabs.github.io/ropsec/articles/sign-commits.html).
```{r eval = FALSE}
key <- sign_commits_with_key("John Doe", "john.doe@gmail.com")
store_public_key(key)
```
<img src="man/figures/signed_commit.png" align="center"/>
### Lightweight system checks
```{r eval=FALSE}
ropsec::summarize_system_checks()
```
```
✔ | OK F W S | Context
✔ | 1 | SSH Configuration - existence
✔ | 2 | SSH Configuration - keys
✔ | 1 | SSH Configuration - key size
✔ | 1 | GPG Existence
✔ | 1 | macOS requires password after sleep or screen saver kicks in [0.1 s]
✖ | 0 1 | Firewall is enabled
# ...
```
### Audit local machine in detail
E.g. what ports are used.
```{r eval = FALSE}
full_audit_results <- full_on_audit()
```
## Collaborators
- Bob Rudis @hrbrmstr
- Kara Woo @karawoo
- Karthik Ram @karthik
- Ildi Czeller @czeildi
Please note that the `ropsec` project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.