mirror of
https://github.com/Lissy93/web-check.git
synced 2025-02-10 07:31:17 +01:00
Updates docs, adds About page
This commit is contained in:
Alicia Sykes
parent
dd2baec866
commit
2657dbbd3a
166
src/pages/About.tsx
Normal file
166
src/pages/About.tsx
Normal file
@ -0,0 +1,166 @@
|
||||
import styled from 'styled-components';
|
||||
|
||||
import colors from 'styles/colors';
|
||||
import Heading from 'components/Form/Heading';
|
||||
import Footer from 'components/misc/Footer';
|
||||
import Nav from 'components/Form/Nav';
|
||||
import Button from 'components/Form/Button';
|
||||
import { StyledCard } from 'components/Form/Card';
|
||||
import docs, { about, license, fairUse } from 'utils/docs';
|
||||
|
||||
|
||||
const AboutContainer = styled.div`
|
||||
width: 80vw;
|
||||
max-width: 1000px;
|
||||
margin: 2rem auto;
|
||||
padding-bottom: 1rem;
|
||||
header {
|
||||
margin 1rem 0;
|
||||
}
|
||||
`;
|
||||
|
||||
const HeaderLinkContainer = styled.nav`
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 1rem;
|
||||
a {
|
||||
text-decoration: none;
|
||||
}
|
||||
`;
|
||||
|
||||
const Section = styled(StyledCard)`
|
||||
margin-bottom: 2rem;
|
||||
h3 {
|
||||
font-size: 1.5rem;
|
||||
}
|
||||
hr {
|
||||
border: none;
|
||||
border-top: 1px dashed ${colors.primary};
|
||||
margin: 1.5rem auto;
|
||||
}
|
||||
ul {
|
||||
padding: 0 0 0 1rem;
|
||||
list-style: circle;
|
||||
}
|
||||
a {
|
||||
color: ${colors.primary};
|
||||
&:visited { opacity: 0.8; }
|
||||
}
|
||||
pre {
|
||||
background: ${colors.background};
|
||||
border-radius: 4px;
|
||||
padding: 0.5rem;
|
||||
width: fit-content;
|
||||
}
|
||||
small { opacity: 0.7; }
|
||||
.contents {
|
||||
ul {
|
||||
list-style: none;
|
||||
li {
|
||||
a {
|
||||
// color: ${colors.textColor};
|
||||
&:visited { opacity: 0.8; }
|
||||
}
|
||||
b {
|
||||
opacity: 0.75;
|
||||
display: inline-block;
|
||||
width: 1.5rem;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
`;
|
||||
|
||||
const makeAnchor = (title: string): string => {
|
||||
return title.toLowerCase().replace(/[^\w\s]|_/g, "").replace(/\s+/g, "-");
|
||||
};
|
||||
|
||||
|
||||
const About = (): JSX.Element => {
|
||||
return (
|
||||
<div>
|
||||
<AboutContainer>
|
||||
<Nav>
|
||||
<HeaderLinkContainer>
|
||||
<a href="https://github.com/lissy93/web-check"><Button>View on GitHub</Button></a>
|
||||
</HeaderLinkContainer>
|
||||
</Nav>
|
||||
|
||||
<Heading as="h2" size="medium" color={colors.primary}>Intro</Heading>
|
||||
<Section>
|
||||
{about.map((para, index: number) => (
|
||||
<p key={index}>{para}</p>
|
||||
))}
|
||||
</Section>
|
||||
|
||||
<Heading as="h2" size="medium" color={colors.primary}>Features</Heading>
|
||||
<Section>
|
||||
<div className="contents">
|
||||
<Heading as="h3" size="small" id="#feature-contents" color={colors.primary}>Contents</Heading>
|
||||
<ul>
|
||||
{docs.map((section, index: number) => (
|
||||
<li>
|
||||
<b>{index + 1}</b>
|
||||
<a href={`#${makeAnchor(section.title)}`}>{section.title}</a></li>
|
||||
))}
|
||||
</ul>
|
||||
<hr />
|
||||
</div>
|
||||
{docs.map((section, sectionIndex: number) => (
|
||||
<section key={section.title}>
|
||||
<Heading as="h3" size="small" id={makeAnchor(section.title)} color={colors.primary}>{section.title}</Heading>
|
||||
<Heading as="h4" size="small">Description</Heading>
|
||||
<p>{section.description}</p>
|
||||
<Heading as="h4" size="small">Use Cases</Heading>
|
||||
<p>{section.use}</p>
|
||||
<Heading as="h4" size="small">Useful Links</Heading>
|
||||
<ul>
|
||||
{section.resources.map((link: string) => (
|
||||
<li><a href={link}>{link}</a></li>
|
||||
))}
|
||||
</ul>
|
||||
{ sectionIndex < docs.length - 1 && <hr /> }
|
||||
</section>
|
||||
))}
|
||||
</Section>
|
||||
|
||||
<Heading as="h2" size="medium" color={colors.primary}>Terms & Info</Heading>
|
||||
<Section>
|
||||
<Heading as="h3" size="small" color={colors.primary}>License</Heading>
|
||||
<b>
|
||||
<a href="https://github.com/lissy93/web-check">Web-Check</a> is distributed under the MIT license,
|
||||
© <a href="https://aliciasykes.com">Alicia Sykes</a> { new Date().getFullYear()}
|
||||
</b>
|
||||
<br />
|
||||
<small>For more info, see <a href="https://tldrlegal.com/license/mit-license">TLDR Legal → MIT</a></small>
|
||||
<pre>{license}</pre>
|
||||
<hr />
|
||||
<Heading as="h3" size="small" color={colors.primary}>Fair Use</Heading>
|
||||
<ul>
|
||||
{fairUse.map((para, index: number) => (<li>{para}</li>))}
|
||||
</ul>
|
||||
<hr />
|
||||
<Heading as="h3" size="small" color={colors.primary}>Privacy</Heading>
|
||||
<p>
|
||||
Analytics are used on the demo instance (via a self-hosted Plausible instance), this only records the URL you visited but no personal data.
|
||||
</p>
|
||||
<hr />
|
||||
<Heading as="h3" size="small" color={colors.primary}>Support</Heading>
|
||||
<p>
|
||||
If you've found something that doesn't work as expected, or would like to ask any questions,
|
||||
you can open a ticket at <a href="https://github.com/lissy93/web-check/issues">github.com/lissy93/web-check/issues</a>
|
||||
</p>
|
||||
<hr />
|
||||
<Heading as="h3" size="small" color={colors.primary}>Sponsor</Heading>
|
||||
<p>
|
||||
If you've found this service useful, consider sponsoring me on
|
||||
GitHub - <a href="https://github.com/sponsors/Lissy93">github.com/sponsors/Lissy93</a> 💖
|
||||
</p>
|
||||
</Section>
|
||||
</AboutContainer>
|
||||
<Footer />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export default About;
|
||||
@ -227,6 +227,72 @@ const docs: Doc[] = [
|
||||
"https://whois.domaintools.com/",
|
||||
],
|
||||
},
|
||||
{
|
||||
id: "dnssec",
|
||||
title: "DNS Security Extensions",
|
||||
description:
|
||||
"Without DNSSEC, it\'s possible for MITM attackers to spoof records and lead users to phishing sites. This is because the DNS system includes no built-in methods to verify that the response to the request was not forged, or that any other part of the process wasn’t interrupted by an attacker. The DNS Security Extensions (DNSSEC) secures DNS lookups by signing your DNS records using public keys, so browsers can detect if the response has been tampered with. Another solution to this issue is DoH (DNS over HTTPS) and DoT (DNS over TLD).",
|
||||
use: "DNSSEC information provides insight into an organization's level of cybersecurity maturity and potential vulnerabilities, particularly around DNS spoofing and cache poisoning. If no DNS secururity (DNSSEC, DoH, DoT, etc) is implemented, this may provide an entry point for an attacker.",
|
||||
resources: [
|
||||
"https://dnssec-analyzer.verisignlabs.com/",
|
||||
"https://www.cloudflare.com/dns/dnssec/how-dnssec-works/",
|
||||
"https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions",
|
||||
"https://www.icann.org/resources/pages/dnssec-what-is-it-why-important-2019-03-05-en",
|
||||
"https://support.google.com/domains/answer/6147083",
|
||||
"https://www.internetsociety.org/resources/deploy360/2013/dnssec-test-sites/",
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
export const about = [
|
||||
`Web-Check is a powerful all-in-one tool for discovering information about a website/host.
|
||||
The core philosophy is simple: feed Web-Check a URL and let it gather, collate, and present a broad array of open data for you to delve into.`,
|
||||
|
||||
`The report shines a spotlight onto potential attack vectors, existing security measures,
|
||||
and the intricate web of connections within a site's architecture.
|
||||
The results can also help optimizing server responses, configuring redirects,
|
||||
managing cookies, or fine-tuning DNS records for your site.`,
|
||||
|
||||
`So, weather you're a developer, system administrator, security researcher, penetration
|
||||
tester or are just interested in discovering the underlying technologies of a given site
|
||||
- I'm sure you'll find this a useful addition to your toolbox.`,
|
||||
|
||||
`It works using a series of lambda functions, each of which makes a crafted fetch
|
||||
request to the host, processes the returned data, then responds with the results.
|
||||
The web UI is just a simple React TypeScript app.`,
|
||||
|
||||
`There's a managed instance (hosted on Netlify), which you can use for free
|
||||
(until my lambda function credits run out!), or you can easily deploy your own
|
||||
instance locally or remotely.
|
||||
All the code is open source, so feel free to fork and modify to your liking.
|
||||
For development and deployment instructions, as well as contributing guidelines, see the GitHub repo.
|
||||
`];
|
||||
|
||||
export const license = `The MIT License (MIT)
|
||||
Copyright (c) Alicia Sykes <alicia@omg.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is furnished
|
||||
to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included install
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
`;
|
||||
|
||||
export const fairUse = [
|
||||
'Please use this tool responsibly. Do not use it for hosts you do not have permission to scan. Do not use it to attack or disrupt services.',
|
||||
'Requests are rate-limited to prevent abuse. If you need to make more bandwidth, please deploy your own instance.',
|
||||
'The hosted instance is only for demo use, as excessive use will quickly deplete my lambda function credits, making it unavailable for others and/or costing me money.',
|
||||
];
|
||||
|
||||
export default docs;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user