code-server/src/node/http.ts at v4.93.1 · coder/code-server · GitHub

History

425 lines (384 loc) · 13.7 KB

Raw

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

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

import { field, logger } from "@coder/logger"

import * as express from "express"

import * as expressCore from "express-serve-static-core"

import * as http from "http"

import * as net from "net"

import * as qs from "qs"

import { Disposable } from "../common/emitter"

import { CookieKeys, HttpCode, HttpError } from "../common/http"

import { normalize } from "../common/util"

import { AuthType, DefaultedArgs } from "./cli"

import { version as codeServerVersion } from "./constants"

import { Heart } from "./heart"

import { CoderSettings, SettingsProvider } from "./settings"

import { UpdateProvider } from "./update"

import {

getPasswordMethod,

IsCookieValidArgs,

isCookieValid,

sanitizeString,

escapeHtml,

escapeJSON,

splitOnFirstEquals,

} from "./util"

/**

* Base options included on every page.

export interface ClientConfiguration {

codeServerVersion: string

/** Relative path from this page to the root. No trailing slash. */

base: string

/** Relative path from this page to the static root. No trailing slash. */

csStaticBase: string

}

declare global {

// eslint-disable-next-line @typescript-eslint/no-namespace

namespace Express {

export interface Request {

args: DefaultedArgs

heart: Heart

settings: SettingsProvider<CoderSettings>

updater: UpdateProvider

}

export const createClientConfiguration = (req: express.Request): ClientConfiguration => {

const base = relativeRoot(req.originalUrl)

return {

base,

csStaticBase: base + "/_static",

codeServerVersion,

}

/**

* Replace common variable strings in HTML templates.

export const replaceTemplates = <T extends object>(

req: express.Request,

content: string,

extraOpts?: Omit<T, "base" | "csStaticBase" | "logLevel">,

): string => {

const serverOptions: ClientConfiguration = {

...createClientConfiguration(req),

...extraOpts,

}

return content

.replace(/{{TO}}/g, (typeof req.query.to === "string" && escapeHtml(req.query.to)) || "/")

.replace(/{{BASE}}/g, serverOptions.base)

.replace(/{{CS_STATIC_BASE}}/g, serverOptions.csStaticBase)

.replace("{{OPTIONS}}", () => escapeJSON(serverOptions))

}

/**

* Throw an error if proxy is not enabled. Call `next` if provided.

export const ensureProxyEnabled = (req: express.Request, _?: express.Response, next?: express.NextFunction): void => {

if (!proxyEnabled(req)) {

throw new HttpError("Forbidden", HttpCode.Forbidden)

}

if (next) {

next()

}

/**

* Return true if proxy is enabled.

export const proxyEnabled = (req: express.Request): boolean => {

return !req.args["disable-proxy"]

}

/**

* Throw an error if not authorized. Call `next` if provided.

export const ensureAuthenticated = async (

req: express.Request,

_?: express.Response,

next?: express.NextFunction,

): Promise<void> => {

const isAuthenticated = await authenticated(req)

if (!isAuthenticated) {

throw new HttpError("Unauthorized", HttpCode.Unauthorized)

}

if (next) {

next()

}

/**

* Return true if authenticated via cookies.

export const authenticated = async (req: express.Request): Promise<boolean> => {

switch (req.args.auth) {

case AuthType.None: {

return true

}

case AuthType.Password: {

// The password is stored in the cookie after being hashed.

const hashedPasswordFromArgs = req.args["hashed-password"]

const passwordMethod = getPasswordMethod(hashedPasswordFromArgs)

const isCookieValidArgs: IsCookieValidArgs = {

passwordMethod,

cookieKey: sanitizeString(req.cookies[CookieKeys.Session]),

passwordFromArgs: req.args.password || "",

hashedPasswordFromArgs: req.args["hashed-password"],

}

return await isCookieValid(isCookieValidArgs)

}

default: {

throw new Error(`Unsupported auth type ${req.args.auth}`)

}

/**

* Get the relative path that will get us to the root of the page. For each

* slash we need to go up a directory. Will not have a trailing slash.

* For example:

* / => .

* /foo => .

* /foo/ => ./..

* /foo/bar => ./..

* /foo/bar/ => ./../..

* All paths must be relative in order to work behind a reverse proxy since we

* we do not know the base path. Anything that needs to be absolute (for

* example cookies) must get the base path from the frontend.

* All relative paths must be prefixed with the relative root to ensure they

* work no matter the depth at which they happen to appear.

* For Express `req.originalUrl` should be used as they remove the base from the

* standard `url` property making it impossible to get the true depth.

export const relativeRoot = (originalUrl: string): string => {

const depth = (originalUrl.split("?", 1)[0].match(/\//g) || []).length

return normalize("./" + (depth > 1 ? "../".repeat(depth - 1) : ""))

}

/**

* A helper function to construct a redirect path based on

* an Express Request, query and a path to redirect to.

* Redirect path is relative to `/${to}`.

export const constructRedirectPath = (req: express.Request, query: qs.ParsedQs, to: string): string => {

const relativePath = normalize(`${relativeRoot(req.originalUrl)}/${to}`, true)

// %2f or %2F are both equalivent to an encoded slash /

const queryString = qs.stringify(query).replace(/%2[fF]/g, "/")

const redirectPath = `${relativePath}${queryString ? `?${queryString}` : ""}`

return redirectPath

}

/**

* Redirect relatively to `/${to}`. Query variables on the current URI will be

* preserved. `to` should be a simple path without any query parameters

* `override` will merge with the existing query (use `undefined` to unset).

export const redirect = (

req: express.Request,

res: express.Response,

to: string,

override: expressCore.Query = {},

): void => {

const query = Object.assign({}, req.query, override)

Object.keys(override).forEach((key) => {

if (typeof override[key] === "undefined") {

delete query[key]

}

})

const redirectPath = constructRedirectPath(req, query, to)

logger.debug(`redirecting from ${req.originalUrl} to ${redirectPath}`)

res.redirect(redirectPath)

}

/**

* Get the value that should be used for setting a cookie domain. This will

* allow the user to authenticate once no matter what sub-domain they use to log

* in. This will use the highest level proxy domain (e.g. `coder.com` over

* `test.coder.com` if both are specified).

export const getCookieDomain = (host: string, proxyDomains: string[]): string | undefined => {

const idx = host.lastIndexOf(":")

host = idx !== -1 ? host.substring(0, idx) : host

// If any of these are true we will still set cookies but without an explicit

// `Domain` attribute on the cookie.

if (

// The host can be be blank or missing so there's nothing we can set.

!host ||

// IP addresses can't have subdomains so there's no value in setting the

// domain for them. Assume that anything with a : is ipv6 (valid domain name

// characters are alphanumeric or dashes)...

host.includes(":") ||

// ...and that anything entirely numbers and dots is ipv4 (currently tlds

// cannot be entirely numbers).

!/[^0-9.]/.test(host) ||

// localhost subdomains don't seem to work at all (browser bug?). A cookie

// set at dev.localhost cannot be read by 8080.dev.localhost.

host.endsWith(".localhost") ||

// Domains without at least one dot (technically two since domain.tld will

// become .domain.tld) are considered invalid according to the spec so don't

// set the domain for them. In my testing though localhost is the only

// problem (the browser just doesn't store the cookie at all). localhost has

// an additional problem which is that a reverse proxy might give

// code-server localhost even though the domain is really domain.tld (by

// default NGINX does this).

!host.includes(".")

) {

logger.debug("no valid cookie domain", field("host", host))

return undefined

}

proxyDomains.forEach((domain) => {

if (host.endsWith(domain) && domain.length < host.length) {

host = domain

}

})

logger.debug("got cookie domain", field("host", host))

return host || undefined

}

/**

* Return a function capable of fully disposing an HTTP server.

export function disposer(server: http.Server): Disposable["dispose"] {

const sockets = new Set<net.Socket>()

let cleanupTimeout: undefined | NodeJS.Timeout

server.on("connection", (socket) => {

sockets.add(socket)

socket.on("close", () => {

sockets.delete(socket)

if (cleanupTimeout && sockets.size === 0) {

clearTimeout(cleanupTimeout)

cleanupTimeout = undefined

}

})

return () => {

return new Promise<void>((resolve, reject) => {

// The whole reason we need this disposer is because close will not

// actually close anything; it only prevents future connections then waits

// until everything is closed.

server.close((err) => {

if (err) {

return reject(err)

}

resolve()

})

// If there are sockets remaining we might need to force close them or

// this promise might never resolve.

if (sockets.size > 0) {

// Give sockets a chance to close up shop.

cleanupTimeout = setTimeout(() => {

cleanupTimeout = undefined

for (const socket of sockets.values()) {

console.warn("a socket was left hanging")

socket.destroy()

}

}, 1000)

}

})

}

/**

* Get the options for setting a cookie. The options must be identical for

* setting and unsetting cookies otherwise they are considered separate.

export const getCookieOptions = (req: express.Request): express.CookieOptions => {

// Normally we set paths relatively. However browsers do not appear to allow

// cookies to be set relatively which means we need an absolute path. We

// cannot be guaranteed we know the path since a reverse proxy might have

// rewritten it. That means we need to get the path from the frontend.

// The reason we need to set the path (as opposed to defaulting to /) is to

// avoid code-server instances on different sub-paths clobbering each other or

// from accessing each other's tokens (and to prevent other services from

// accessing code-server's tokens).

// When logging in or out the request must include the href (the full current

// URL of that page) and the relative path to the root as given to it by the

// backend. Using these two we can determine the true absolute root.

const url = new URL(

req.query.base || req.body?.base || "/",

req.query.href || req.body?.href || "http://" + (req.headers.host || "localhost"),

)

return {

domain: getCookieDomain(url.host, req.args["proxy-domain"]),

path: normalize(url.pathname) || "/",

sameSite: "lax",

}

/**

* Return the full path to the current page, preserving any trailing slash.

export const self = (req: express.Request): string => {

return normalize(`${req.baseUrl}${req.originalUrl.endsWith("/") ? "/" : ""}`, true)

}

function getFirstHeader(req: http.IncomingMessage, headerName: string): string | undefined {

const val = req.headers[headerName]

return Array.isArray(val) ? val[0] : val

}

/**

* Throw a forbidden error if origin checks fail. Call `next` if provided.

export function ensureOrigin(req: express.Request, _?: express.Response, next?: express.NextFunction): void {

try {

authenticateOrigin(req)

if (next) {

next()

}

} catch (error) {

logger.debug(`${error instanceof Error ? error.message : error}; blocking request to ${req.originalUrl}`)

throw new HttpError("Forbidden", HttpCode.Forbidden)

}

/**

* Authenticate the request origin against the host. Throw if invalid.

export function authenticateOrigin(req: express.Request): void {

// A missing origin probably means the source is non-browser. Not sure we

// have a use case for this but let it through.

const originRaw = getFirstHeader(req, "origin")

if (!originRaw) {

return

}

let origin: string

try {

origin = new URL(originRaw).host.trim().toLowerCase()

} catch (error) {

throw new Error(`unable to parse malformed origin "${originRaw}"`)

}

const trustedOrigins = req.args["trusted-origins"] || []

if (trustedOrigins.includes(origin) || trustedOrigins.includes("*")) {

return

}

const host = getHost(req)

if (typeof host === "undefined") {

// A missing host likely means the reverse proxy has not been configured to

// forward the host which means we cannot perform the check. Emit an error

// so an admin can fix the issue.

logger.error("No host headers found")

logger.error("Are you behind a reverse proxy that does not forward the host?")

throw new Error("no host headers found")

}

if (host !== origin) {

throw new Error(`host "${host}" does not match origin "${origin}"`)

}

/**

* Get the host from headers. It will be trimmed and lowercased.

export function getHost(req: express.Request): string | undefined {

// Honor Forwarded if present.

const forwardedRaw = getFirstHeader(req, "forwarded")

if (forwardedRaw) {

const parts = forwardedRaw.split(/[;,]/)

for (let i = 0; i < parts.length; ++i) {

const [key, value] = splitOnFirstEquals(parts[i])

if (key.trim().toLowerCase() === "host" && value) {

return value.trim().toLowerCase()

}

// Honor X-Forwarded-Host if present. Some reverse proxies will set multiple

// comma-separated hosts.

const xHost = getFirstHeader(req, "x-forwarded-host")

if (xHost) {

const firstXHost = xHost.split(",")[0]

if (firstXHost) {

return firstXHost.trim().toLowerCase()

}

const host = getFirstHeader(req, "host")

return host ? host.trim().toLowerCase() : undefined

}

code-server/src/node/http.ts at v4.93.1 · coder/code-server · GitHub

Uh oh!

Expand file tree

Breadcrumbs

http.ts

Latest commit

History

Breadcrumbs

http.ts

File metadata and controls