-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathintermediate_git_presentation.html
More file actions
391 lines (298 loc) · 12.2 KB
/
intermediate_git_presentation.html
File metadata and controls
391 lines (298 loc) · 12.2 KB
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>Intermediate Git and Github: Security</title>
<meta charset="utf-8" />
<meta name="author" content="Jenny Leopoldina Smith" />
<meta name="date" content="2021-09-27" />
<script src="libs/header-attrs-2.11/header-attrs.js"></script>
<link href="libs/remark-css-0.0.1/default.css" rel="stylesheet" />
<link href="libs/remark-css-0.0.1/default-fonts.css" rel="stylesheet" />
</head>
<body>
<textarea id="source">
class: center, middle, inverse, title-slide
# Intermediate Git and Github: Security
## An Introduction
### Jenny Leopoldina Smith
### Fred Hutchinson Cancer Research Center
### 2021-09-27
---
name: intro
# Introduction
- I will be discussing some a very **general overview** of security when using Git and Github
--
.pull-left[
- This is not an exhaustive list
- The goal is only to spread awareness of security issues
- *Security practices change over time*
- Be sure to periodically check around Github's blogs, or software you use (an example would be Docker containers or cloud services), or a friendly co-worker, occasionally to discuss
]
.pull-right[
]
---
# Protect Against Secrets in Git Repositories
- This is an overview of the "best practices" highlighted in a post by the computational biologist Sean Davis<sup>1,2</sup>, but its relevant to everyone.
--
- In this example, the author using github included their secret key for AWS directly into code + committed the change in a local repo.
--
- The key was used to access AWS and use resources the author was paying for!
--
- To be proactive - check out [`git-secrets`](https://github.com/awslabs/git-secrets) to secure your passwords and sensitive information!
<!-- From the blog: re-phrase for presentation I deleted the GitHub repo and did some local checking and, in retrospect, realized my mistake. Git had dutifully saved the entire history of my project including a version of one file with AWS keys in it. Upon pushing to GitHub, the keys were there in the history. I breathed a sigh of relief that no harm had been done. -->
<img src="https://i.ytimg.com/vi/4fZKJ90GVHg/mqdefault.jpg" width="40%" height="40%" style="display: block; margin: auto 0 auto auto;" />
--
.footnote[
[1] [Sean Davis, post on Medium](https://medium.com/@seandavis12/protect-against-secrets-in-git-repositories-a531038fac7e)
[2] [Sean Davis, post on Personal Blog](https://seandavi.github.io/post/protect-against-secrets-in-git-repositories/)
[3] Image credit: [github blog](https://github.blog/2021-01-11-github-security-features-highlights-from-2020/)
]
---
name: git-secrets-cont1
# git-secrets
- The code snippet is directly from the blog post.
- If you use a Mac, installation is easy with `homebrew`
--
- To try it out, you can make toy git repo to test the functionality.
````markdown
```{bash}
# create an example git repo
mkdir secrets_example #<<
cd secrets_example #<<
git init #<<
# now "install" the git-secrets hook
git secrets --install #<<
```
````
---
name: git-secrets-cont2
# git-secrets
- once installed, list any secrects detected in your environment with `git secrets --list`
- Then add a simple example password to git-secrets configuration
- Try to commit a file containing your password
--
````markdown
```{bash}
git secrets --add 'MyPASSWORD[0-9]+' #<<
echo 'MyPASSWORD123' >> test.file
git add test.file #<<
git commit -m 'test file with password' #<<
```
````
- the output: `[ERROR] Matched one or more prohibited patterns`
.footnote[
Additional Info: [best practices for AWS keys](http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html)
]
---
background-image: url(https://usethis.r-lib.org/logo.png)
background-position: right top
# R package: `usethis` for Guidance
.pull-left[
- The package `usethis` provides a fantastic overview of getting started with git and github for beginner to advanced users.
]
.pull-right[
]
--
- The [vignette](https://usethis.r-lib.org/articles/articles/usethis-setup.html) covers the following concepts:
--
- How to get a free GitHub.com account and install Git.
--
- Configure your Git user.name and user.email
--
- Reviews how RStudio can find your Git executable
--
- Reviews how you can pull/push from your local computer to GitHub.com, in general and from RStudio
--
- Reviews how to get a personal access token (PAT) from GitHub.com and make it available in R sessions
--
---
# R package: `usethis` for Guidance
- To begin, install the package and configure your .Rprofile and git.
````markdown
```{r tidy=TRUE}
library(usethis)
usethis::edit_r_profile() #Set HTTPS for github protocol
use_git_config(user.name = "Jane Doe",
user.email = "jane@example.com")
```
````
--
- Some useful functions from `usethis` for use with github are:
1. `create_project()`
2. `use_git()` and `use_github()`
3. `git_vaccinate()`
4. `git_sitrep()`
5. `gh_token_help()`
--
> `git_vaccinate()` Adds .DS_Store, .Rproj.user, .Rdata, .Rhistory, and .httr-oauth to your global (a.k.a. user-level) .gitignore. This is good practice as it decreases the chance that you will accidentally leak credentials to GitHub.
---
background-image: url(https://usethis.r-lib.org/logo.png)
background-position: bottom center
# R package: `usethis` for Guidance
- To enable git and github, you will have to configure your PAT (personal access token)
- It might seem overwhelming, but getting and setting up your PAT can be done!
- Again, there is a [full article](https://usethis.r-lib.org/articles/articles/usethis-setup.html) from `usethis` covering the topic: "Managing Git(Hub) Credentials".
---
# Setting up Git Credentials
1) MacOS and Linux to [store credentials](https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git) for GitHub over HTTPS
- Installatipn of a credenial manager `brew install --cask git-credential-manager-core`
- "The next time you clone an HTTPS URL that requires authentication, Git will prompt you to log in using a browser window."
--
2) Another useful follow-up function is `usethis::gh_token_help()` which can provide helpful prompts!
````markdown
• GitHub host: 'https://github.com'
• Host online: TRUE
• Personal access token for 'https://github.com': '<discovered>'
ℹ Call `gh::gh_whoami()` to see info about your token, e.g. the associated user
ℹ To see or update the token, call `gitcreds::gitcreds_set()`
✓ If those results are OK, you are good go to!
ℹ Read more in the 'Managing Git(Hub) Credentials' article:
https://usethis.r-lib.org/articles/articles/git-credentials.html
````
---
background-image: url("images/tweet_example.png")
background-position: top right
background-size: 40% 80%
# Mistakes Happen
.pull-left[
- Remember security is a community issue, and its always evolving.
]
.pull-right[
]
--
- For example, the vignette from `usethis` has changed significantly over the last few years from storing your `.Renviron` file.
> This means we can stop storing GitHub PATs in plain text in a startup file, like .Renviron 4. This, in turn, reduces the risk of accidentally leaking your credentials.
--
- Leaks can and will happen.
- And there are active pushes to address these, with [secret scanning](https://github.blog/2021-01-11-github-security-features-highlights-from-2020/) enabled in github repos
--
- As recently as mid-September 2021,`travis-ci` leaked nearly all users keys, passwords, and other sensitive information.
---
name: end
class: center middle
# Thanks!
Please feel free to contact me: *JennyL.Smith12 [at] gmail.com*
.footnote[
[1] Slides created with the R package [**xaringan**](https://github.com/yihui/xaringan).
]
</textarea>
<style data-target="print-only">@media screen {.remark-slide-container{display:block;}.remark-slide-scaler{box-shadow:none;}}</style>
<script src="https://remarkjs.com/downloads/remark-latest.min.js"></script>
<script>var slideshow = remark.create({
"highlightStyle": "github",
"highlightLines": true,
"countIncrementalSlides": false
});
if (window.HTMLWidgets) slideshow.on('afterShowSlide', function (slide) {
window.dispatchEvent(new Event('resize'));
});
(function(d) {
var s = d.createElement("style"), r = d.querySelector(".remark-slide-scaler");
if (!r) return;
s.type = "text/css"; s.innerHTML = "@page {size: " + r.style.width + " " + r.style.height +"; }";
d.head.appendChild(s);
})(document);
(function(d) {
var el = d.getElementsByClassName("remark-slides-area");
if (!el) return;
var slide, slides = slideshow.getSlides(), els = el[0].children;
for (var i = 1; i < slides.length; i++) {
slide = slides[i];
if (slide.properties.continued === "true" || slide.properties.count === "false") {
els[i - 1].className += ' has-continuation';
}
}
var s = d.createElement("style");
s.type = "text/css"; s.innerHTML = "@media print { .has-continuation { display: none; } }";
d.head.appendChild(s);
})(document);
// delete the temporary CSS (for displaying all slides initially) when the user
// starts to view slides
(function() {
var deleted = false;
slideshow.on('beforeShowSlide', function(slide) {
if (deleted) return;
var sheets = document.styleSheets, node;
for (var i = 0; i < sheets.length; i++) {
node = sheets[i].ownerNode;
if (node.dataset["target"] !== "print-only") continue;
node.parentNode.removeChild(node);
}
deleted = true;
});
})();
(function() {
"use strict"
// Replace <script> tags in slides area to make them executable
var scripts = document.querySelectorAll(
'.remark-slides-area .remark-slide-container script'
);
if (!scripts.length) return;
for (var i = 0; i < scripts.length; i++) {
var s = document.createElement('script');
var code = document.createTextNode(scripts[i].textContent);
s.appendChild(code);
var scriptAttrs = scripts[i].attributes;
for (var j = 0; j < scriptAttrs.length; j++) {
s.setAttribute(scriptAttrs[j].name, scriptAttrs[j].value);
}
scripts[i].parentElement.replaceChild(s, scripts[i]);
}
})();
(function() {
var links = document.getElementsByTagName('a');
for (var i = 0; i < links.length; i++) {
if (/^(https?:)?\/\//.test(links[i].getAttribute('href'))) {
links[i].target = '_blank';
}
}
})();
// adds .remark-code-has-line-highlighted class to <pre> parent elements
// of code chunks containing highlighted lines with class .remark-code-line-highlighted
(function(d) {
const hlines = d.querySelectorAll('.remark-code-line-highlighted');
const preParents = [];
const findPreParent = function(line, p = 0) {
if (p > 1) return null; // traverse up no further than grandparent
const el = line.parentElement;
return el.tagName === "PRE" ? el : findPreParent(el, ++p);
};
for (let line of hlines) {
let pre = findPreParent(line);
if (pre && !preParents.includes(pre)) preParents.push(pre);
}
preParents.forEach(p => p.classList.add("remark-code-has-line-highlighted"));
})(document);</script>
<script>
slideshow._releaseMath = function(el) {
var i, text, code, codes = el.getElementsByTagName('code');
for (i = 0; i < codes.length;) {
code = codes[i];
if (code.parentNode.tagName !== 'PRE' && code.childElementCount === 0) {
text = code.textContent;
if (/^\\\((.|\s)+\\\)$/.test(text) || /^\\\[(.|\s)+\\\]$/.test(text) ||
/^\$\$(.|\s)+\$\$$/.test(text) ||
/^\\begin\{([^}]+)\}(.|\s)+\\end\{[^}]+\}$/.test(text)) {
code.outerHTML = code.innerHTML; // remove <code></code>
continue;
}
}
i++;
}
};
slideshow._releaseMath(document);
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement('script');
script.type = 'text/javascript';
script.src = 'https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-MML-AM_CHTML';
if (location.protocol !== 'file:' && /^https?:/.test(script.src))
script.src = script.src.replace(/^https?:/, '');
document.getElementsByTagName('head')[0].appendChild(script);
})();
</script>
</body>
</html>