Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jumpingrivers/serverheaders
R package for extracting and assessing server headers.
https://github.com/jumpingrivers/serverheaders
Last synced: about 2 months ago
JSON representation
R package for extracting and assessing server headers.
- Host: GitHub
- URL: https://github.com/jumpingrivers/serverheaders
- Owner: jumpingrivers
- License: other
- Created: 2023-03-16T11:30:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-04T15:04:09.000Z (6 months ago)
- Last Synced: 2024-04-04T16:31:54.468Z (6 months ago)
- Language: R
- Size: 26.4 KB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - jumpingrivers/serverheaders - R package for extracting and assessing server headers. (R)
README
# Server Headers
A simple interface to retrieve and examine HTTP headers from a website.
The package is installed in the usual way
```
install.packages('serverHeaders', repos = c('https://jumpingrivers.r-universe.dev', 'https://cloud.r-project.org'))
```
The main function is `check()`
```
library("serverHeaders")
x = check("google.com")
```
The output from `check()` is contains the status code `x$status_code` and a data frame
of headers `x$headers`. The data frame provides information about each header.
Note: An unknown header is expected.
## Flagged Headers
As every web-page is different, there isn't a "one-size fits all" approach to server headers.
These headings take a variety of values and need to be constructed to match the set.
However, there are a number of headings that some people suggest should be set.
When you `check()` these headings are printed to the console and also indicated in the console
output.
For example, running
```
check("jumpingrivers.com")
# ── Checking Server ──
#
# ✔ Status code: 200
# ✖ content-security-policy: Header not set (Docs)
# ✖ permissions-policy: Header not set (Docs)
# ✔ referrer-policy: Acceptable setting found
# ✔ strict-transport-security: max_age present and greater than 1 year
# ✔ x-content-type-options: Acceptable setting found
# ✔ x-frame-options: Acceptable setting found
```
highlights we still need to set our content security policy and our permissions policy.
## Status Codes
When we check a website, there are typically a few redirects before we reach the final destination.
For example,
> http://jumpingrivers.com -> https://jumpingrivers.com -> https://www.jumpingrivers.com
This corresponds to
```
check("jumpingrivers.com")$status_codes
# 301 301 200
```
Where `301` indicates a redirect and `200` the final successful response.
Note: when we omit the transport protocol (the http part), the default is `http`, i.e.
[jumpingrivers.com](https://www.jumprivers.com) is the same as [http://jumpingrivers.com](https://www.jumprivers.com).
---
This package was based on the [hdrs](https://github.com/hrbrmstr/hdrs) R Package by Bob Rudis.