Compare commits
8 Commits
c548abc9ed
...
v0.0.4
| Author | SHA1 | Date | |
|---|---|---|---|
| e0d8849bd1 | |||
| 429613c67e | |||
| 681555fef8 | |||
| 066b9884c2 | |||
| 9311cd3c96 | |||
| 89e6832e73 | |||
| 109f22c231 | |||
| 355338e397 |
@@ -1,3 +1,4 @@
|
|||||||
.env
|
.env
|
||||||
*/.env
|
*/.env
|
||||||
*.md
|
build
|
||||||
|
node_modules
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ FROM node:24-trixie-slim AS builder
|
|||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
RUN npm ci --only=production && npm cache clean --force
|
RUN npm ci && npm cache clean --force
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
FROM node:24-trixie-slim AS production
|
FROM node:24-trixie-slim AS production
|
||||||
|
|||||||
@@ -26,10 +26,14 @@ Running the back-end is as simple as:
|
|||||||
npm ci
|
npm ci
|
||||||
```
|
```
|
||||||
- Copying the .env.default file to .env, and customizing it to own preferences.
|
- Copying the .env.default file to .env, and customizing it to own preferences.
|
||||||
|
|
||||||
**Example:** Say, you want to add a domain to the trusted CORS origins list. To do so, your .env file in your editor of choice and append a comma (`,`) with the origin you want to add (say, `http://example.com`). Your .env file might then look as follows: `TRUSTED_ORIGINS=http://localhost:6568,http://example.com`.
|
**Example:** Say, you want to add a domain to the trusted CORS origins list. To do so, your .env file in your editor of choice and append a comma (`,`) with the origin you want to add (say, `http://example.com`). Your .env file might then look as follows: `TRUSTED_ORIGINS=http://localhost:6568,http://example.com`.
|
||||||
|
|
||||||
**Important:** Make sure to change the `ACCESS_TOKEN_PRIVATE_KEY` variable to something secure, as this secret value will be used to generate user sessions. **Setting a weak key will allow attackers to potentially bruteforce your secret and forge user tokens!**
|
**Important:** Make sure to change the `ACCESS_TOKEN_PRIVATE_KEY` variable to something secure, as this secret value will be used to generate user sessions. **Setting a weak key will allow attackers to potentially bruteforce your secret and forge user tokens!**
|
||||||
- Pasting your wordlist file into `src/tools/wordlist.ts`.
|
- Pasting your wordlist file into `src/tools/wordlist.ts`.
|
||||||
|
|
||||||
No wordlist file exists by default in `src/tools/wordlist.ts`. This is because wordlists were meant to be as modular as possible (with the philosophy of "bring your own wordlist"). If you leave that as-is, you'll run into runtime errors.
|
No wordlist file exists by default in `src/tools/wordlist.ts`. This is because wordlists were meant to be as modular as possible (with the philosophy of "bring your own wordlist"). If you leave that as-is, you'll run into runtime errors.
|
||||||
|
|
||||||
However, if you don't want to provide your own wordlist, and just want to get up and running as fast as possible, you're free to use the provided sample `wordlist.example-large.ts` file. Just copy it into `src/tools/wordlist.ts`:
|
However, if you don't want to provide your own wordlist, and just want to get up and running as fast as possible, you're free to use the provided sample `wordlist.example-large.ts` file. Just copy it into `src/tools/wordlist.ts`:
|
||||||
```sh
|
```sh
|
||||||
cp wordlist.example-large.ts src/tools/wordlist.ts
|
cp wordlist.example-large.ts src/tools/wordlist.ts
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "kittyBE",
|
"name": "kittyBE",
|
||||||
"version": "0.0.1",
|
"version": "0.0.3",
|
||||||
"description": "Your go-to place for short and memorable URLs.",
|
"description": "Your go-to place for short and memorable URLs.",
|
||||||
"type": "commonjs",
|
"type": "commonjs",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|||||||
@@ -91,7 +91,7 @@ AppDataSource.initialize().then(async () => {
|
|||||||
|
|
||||||
// Retrieve url, subdomain from request.
|
// Retrieve url, subdomain from request.
|
||||||
let uri: string = req.url.slice(1); // discards / from /abc, /abc -> abc
|
let uri: string = req.url.slice(1); // discards / from /abc, /abc -> abc
|
||||||
let subdomain: string | null = req.headers.host!.replace(rs.fqdn, '') || null;
|
let subdomain: string | null = req.headers.host!.replace(rs.fqdn, '').slice(0, -1) || null; // slice() to remove trailing dot
|
||||||
|
|
||||||
// Try to lookup the url in DB
|
// Try to lookup the url in DB
|
||||||
const reversedLink: Link | null = await linkService.lookupUriWithExpiryValidation(uri, subdomain);
|
const reversedLink: Link | null = await linkService.lookupUriWithExpiryValidation(uri, subdomain);
|
||||||
|
|||||||
@@ -15,5 +15,5 @@ export const AppDataSource = new DataSource({
|
|||||||
entities: [__dirname + '/entities/*.ts'],
|
entities: [__dirname + '/entities/*.ts'],
|
||||||
migrations: [__dirname + '/migrations/*.ts'],
|
migrations: [__dirname + '/migrations/*.ts'],
|
||||||
subscribers: [],
|
subscribers: [],
|
||||||
parseInt8: true
|
parseInt8: true // https://github.com/typeorm/typeorm/issues/9341#issuecomment-1268986627
|
||||||
})
|
})
|
||||||
|
|||||||
38
src/middleware/requireAdmin.ts
Normal file
38
src/middleware/requireAdmin.ts
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
import { Request, Response, NextFunction } from 'express';
|
||||||
|
import { ErrorDTO } from '../schemas/miscSchema';
|
||||||
|
import * as jwt from '../tools/jwt';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if user has administrative privileges.
|
||||||
|
*
|
||||||
|
* This needs to happen AFTER ensuring this is not a guest session.
|
||||||
|
* So: use requireUser first, and after that requireAdmin to enforce
|
||||||
|
* admin privilege requirement.
|
||||||
|
*
|
||||||
|
* @param {Request} req The request
|
||||||
|
* @param {Response} res The resource
|
||||||
|
* @param {(Function|NextFunction)} next The next
|
||||||
|
* @return {any} Next function on success, unauthorized error otherwise
|
||||||
|
*/
|
||||||
|
const requireAdmin = (req: Request, res: Response, next: NextFunction) => {
|
||||||
|
const user: jwt.JwtStatus = res.locals.user;
|
||||||
|
let error: ErrorDTO | null = null;
|
||||||
|
|
||||||
|
// Check if role is set to 1 (1 = admin, 0 = standard user).
|
||||||
|
if (user.decoded?.role !== 1)
|
||||||
|
error = {
|
||||||
|
status: 'error',
|
||||||
|
error: 'Unauthorized, admin access required',
|
||||||
|
code: 'unauthorized_non_admin'
|
||||||
|
};
|
||||||
|
|
||||||
|
// It is? Send 401 unauthorized.
|
||||||
|
if (error !== null)
|
||||||
|
return res.status(401)
|
||||||
|
.send(error);
|
||||||
|
|
||||||
|
// Otherwise jump to next endpoint.
|
||||||
|
return next();
|
||||||
|
};
|
||||||
|
|
||||||
|
export default requireAdmin;
|
||||||
@@ -1,7 +1,20 @@
|
|||||||
import { Request, Response, NextFunction } from "express";
|
import { Request, Response, NextFunction } from 'express';
|
||||||
import { ErrorDTO } from "../schemas/miscSchema";
|
import { ErrorDTO } from '../schemas/miscSchema';
|
||||||
import * as jwt from "../tools/jwt";
|
import * as jwt from '../tools/jwt';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if user is singed in.
|
||||||
|
* Returns 401 when user is unauthorized.
|
||||||
|
*
|
||||||
|
* To check if user is an admin, chain requireUser and requireAdmin together.
|
||||||
|
* So: use requireUser first, and after that requireAdmin to enforce
|
||||||
|
* admin privilege requirement.
|
||||||
|
*
|
||||||
|
* @param {Request} req The request
|
||||||
|
* @param {Response} res The resource
|
||||||
|
* @param {(Function|NextFunction)} next The next
|
||||||
|
* @return {any} Next function on success, unauthorized error otherwise
|
||||||
|
*/
|
||||||
const requireUser = (req: Request, res: Response, next: NextFunction) => {
|
const requireUser = (req: Request, res: Response, next: NextFunction) => {
|
||||||
const user: jwt.JwtStatus = res.locals.user;
|
const user: jwt.JwtStatus = res.locals.user;
|
||||||
let error: ErrorDTO | null = null;
|
let error: ErrorDTO | null = null;
|
||||||
|
|||||||
@@ -104,9 +104,11 @@ linkRouter.get('/api/v1/link/fromWordlist', validateSchema(ls.sentenceLinkReques
|
|||||||
* post:
|
* post:
|
||||||
* description:
|
* description:
|
||||||
* Register a new shortened URL. <br/>
|
* Register a new shortened URL. <br/>
|
||||||
* See linkSchema.ts for constraints.
|
* See linkSchema.ts for constraints. <br/>
|
||||||
|
* <b>Note:</b> This endpoint's functionality differs depending on the user info,
|
||||||
|
* which means guests will be treated differently from authenticated users.
|
||||||
* tags: [Link]
|
* tags: [Link]
|
||||||
* summary: Shorten a link
|
* summary: "[AUTHED?] Shorten a link"
|
||||||
* requestBody:
|
* requestBody:
|
||||||
* required: true
|
* required: true
|
||||||
* content:
|
* content:
|
||||||
|
|||||||
Reference in New Issue
Block a user