Home / .NET / Web Frameworks

Pode is a Cross-Platform PowerShell web framework for creating REST APIs, Web Sites, and TCP/SMTP servers

Pode Pode is a Cross-Platform framework, completely written in PowerShell, for creating web servers to host REST APIs, Web Pages, and SMTP/TCP Servers. Pode also allows you to render dynamic files using .pode files,
Information
Category: .NET / Web Frameworks
Watchers: 51
Star: 690
Fork: 84
Last update: Sep 27, 2023
Resource links
https://github.com/Badgerati/Pode

Pode

MIT licensed Documentation GitHub Actions AppVeyor Travis CI Code Coverage Gitter

Chocolatey PowerShell Docker

Pode is a Cross-Platform framework, completely written in PowerShell, for creating web servers to host REST APIs, Web Pages, and SMTP/TCP Servers. Pode also allows you to render dynamic files using .pode files, which are just embedded PowerShell, or other Third-Party template engines. Plus many more features, including Azure Functions and AWS Lambda support!

See here for building your first app!

Documentation

All documentation and tutorials for Pode can be found here - this documentation will be for the latest release.

To see the docs for other releases, branches or tags, you can host the documentation locally. To do so you'll need to have the Invoke-Build module installed; then:

Invoke-Build Docs

Then navigate to http://127.0.0.1:8000 in your browser.

Features

  • Cross-platform using PowerShell Core (with support for PS5)
  • Docker support, including images for ARM/Raspberry Pi
  • Azure Functions, AWS Lambda, and IIS support
  • OpenAPI, Swagger, and ReDoc support
  • Listen on a single or multiple IP address/hostnames
  • Cross-platform support for HTTP, HTTPS, TCP and SMTP
  • Cross-platform support for server-to-client WebSockets, including secure WebSockets
  • Host REST APIs, Web Pages, and Static Content (with caching)
  • Support for custom error pages
  • Request and Response compression using GZip/Deflate
  • Multi-thread support for incoming requests
  • Inbuilt template engine, with support for third-parties
  • Async timers for short-running repeatable processes
  • Async scheduled tasks using cron expressions for short/long-running processes
  • Supports logging to CLI, Files, and custom logic for other services like LogStash
  • Cross-state variable access across multiple runspaces
  • Restart the server via file monitoring, or defined periods/times
  • Ability to allow/deny requests from certain IP addresses and subnets
  • Basic rate limiting for IP addresses and subnets
  • Middleware and Sessions on web servers, with Flash message and CSRF support
  • Authentication on requests, such as Basic and Windows Active Directory
  • Support for dynamically building Routes from Functions and Modules
  • (Windows) Generate/bind self-signed certificates, and signed certificates
  • (Windows) Open the hosted server as a desktop application

Install

You can install Pode from either Chocolatey, the PowerShell Gallery, or Docker:

# chocolatey
choco install pode

# powershell gallery
Install-Module -Name Pode

# docker
docker pull badgerati/pode

Contributing

The full contributing guide can be found here

Pull Requests, Bug Reports and Feature Requests are welcome! Feel free to help out with Issues and Projects!

To run the unit tests, run the following command from the root of the repository (this will auto-install Pester for you):

Invoke-Build Test

To work on issues you can fork Pode, and then open a Pull Request for approval. Pull Requests should be made against the develop branch. Each Pull Request should also have an appropriate issue created.

64 Open More issues
Closed

CSRF Example failing

Question

Attempting to use the example at the bottom of https://badgerati.github.io/Pode/Tutorials/Middleware/Types/CSRF/

The view generates the webpage, but when pressing submit Pode says the CSRF token is invalid.

bug :bug: question :grey_question: documentation :book: 
opened Aug 20, 2021 by phatmandrake 27
Closed

Error using Pode with IIS as Reverse proxy in DotnetCore hosting module

When using a Pode Server in IIS like we use Asp.Net Core applications with out of process hosting, I encounter the following error:

In browser HTTP Error 502.5 - ANCM Out-Of-Process Startup Failure

In logs Exception setting "TreatControlCAsInput": "There is no console." At D:\dev\Pode\src\Public\Core.ps1:134 char:13 + [Console]::TreatControlCAsInput = $true

When I disable this line everything works okay.

Steps To Reproduce

  • Install IIS or IIS Express
  • Install DotnetCore Windows Hosting (choco install dotnetcore-windowshosting -y)
  • Create website in IIS and set physical folder to dir with pode server script and add web.config file with contents
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <location path="." inheritInChildApplications="false">
    <system.webServer>
      <handlers>
        <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" resourceType="Unspecified" />
      </handlers>
      <aspNetCore processPath="pwsh.exe" arguments=".\webpages.ps1" stdoutLogEnabled="true" stdoutLogFile=".\logs\stdout" hostingModel="OutOfProcess"/>
    </system.webServer>
  </location>
</configuration>
  • Update Pode\examples\web-simple-pages.ps1 with detecting ASPNETCORE port and address
	$port = 8090
	$address = 'localhost'
	# detect if running in IIS dotnet core app-pool
	if ($env:ASPNETCORE_PORT)
	{
	    $port = $env:ASPNETCORE_PORT
	    $address = '127.0.0.1' # localhost not working
	}
	
	Add-PodeEndpoint -Address $address -Port $port -Protocol Http # replace line

Suggested fixes

1: Add to function Start-Server -Type IIS-Hosting and change Core.Ps1 line 132 with checking ServerType and don't set TreatControlCAsInput

        # set it so ctrl-c can terminate, unless serverless
        if (!$PodeContext.Server.IsServerless) {
            [Console]::TreatControlCAsInput = $true
        }

2: Quick fix ignore error in try/catch or detect no console

enhancement :arrow_up: documentation :book: 
opened Feb 13, 2020 by ehagen 26
Closed

2.0: Drop support for HttpListener, and rewrite the Pode Listener

All right, this one should spark some discussion as it's a big one.

So currently Pode has two ways of running its web server: there's the one that uses HttpListener (the default one), and then there's the Pode one built in PowerShell (-Type Pode on Start-PodeServer) which enables fully xplat SSL and WebSockets - as well as allowing support for hosting Pode via IIS, Azure App Services, and others.

HttpListener is defunct in .NET, so dropping this for just the Pode Listener is ideal - as it supports what HttpListener does, plus allowing more and lets us add more features to the listener as well.

There are however two caveats: performance and complexity.

Under normal circumstances the HttpListener allows for approx. ~180-200req/s - due to being written in .NET and having far better async/event support than PowerShell can deliver.

The Pode Listener can only deliver ~60-70req/s - and this is only because PowerShell's async/event support is dire. Due to this, it also makes the code more complex, and having sleeps everywhere really doesn't help.

If you got this far, then you may have already gathered where this is going - stripping out ONLY the Pode Socket Listener and converting it into C#/.NET Core. This would allow async/events to work as expected, and simplify the code. It might also allow better implementation of KeepAlive on sockets - and allow Client>Server WebSockets rather than just Server>Client.

Now I've already tried this, converting the socket layer to .NET Core, and it works - and boosts the Pode Listener to ~130req/s, and I'm pretty sure I can make that better by using ReceiveAsync on sockets.

But this obviously moves away from Pode being 100% PowerShell, as the Socket Listener will be in C#/.NET Core. So if there's a lot of objection to this, then either we'll keep both HttpListener/Pode or just keep the Pode Listener and keep it as PowerShell.

os:cross-platform internal-code :hammer: 
opened May 25, 2020 by Badgerati 25
Closed

Accessing a variable set inside a timer from a route

I'd like to have a Server timer running every X seconds that will pull some data and update a hash table. I would then like to read from that hash table when a specific api route is called.

I haven't been able to figure out a way to do that. I looked through the readme and the timer example, but that is more about how to create/set a timer, and not about the logic and variables within the timer. Any guidance would be appreciated.

feature :sunny: 
opened Jun 15, 2018 by ssugar 25
Closed

File upload high CPU extremely slow

Uploading a 2MB zip takes 5 minutes. (also tested with Pode.Kestrel) Thank you 🙏

Start-PodeServer {
    Add-PodeEndpoint -Address localhost -Protocol Http
    Use-PodeWebTemplates -Title Tools -Theme Dark

    Add-PodeWebPage -Name P1 -Title T1 -Layouts @(
         New-PodeWebForm -Name 'Form' -AsCard -Content @(
            New-PodeWebFileUpload -Name 'Upload File'
            New-PodeWebTextbox -Name 'New Folder'
            New-PodeWebTextbox -Name 'New File'
        ) -ScriptBlock {
            Write-Warning 'OK'
        }
    )
}
enhancement :arrow_up: 
opened Feb 15, 2021 by ili101 24
Closed

Module is imported partially

Describe the Bug

There is a module called PSLiteDB. Import-Module command imports module to Pode server. But some functions of module are absent.

Steps To Reproduce

Steps to reproduce the behavior:

  1. Install-Module PSLiteDB
  2. Start pode server as per script below
[cmdletbinding()]
param(
   [int] $port = 8090,
   [switch] $debugging
)
$PodeServerParams = @{"Quiet" = !$debugging; "DisableTermination" = !$debugging }

Import-Module Pode -Force #Does not work here

Start-PodeServer @PodeServerParams {
   Add-PodeEndpoint -Address localhost -Port $port -Protocol Http
   #Import-PodeModule -Name "PSLiteDB" #Does not work here either

Add-PodeRoute -Method Get -Path '/awake' -ScriptBlock {
   #Import-Module PSLiteDB -Force #Works here!!!
   Get-Module PSLiteDB | out-string | Write-PodeTextResponse -StatusCode 200
   Get-Command -Module PSLiteDB | out-string | Write-PodeTextResponse -StatusCode 200
}
}
  1. Open the route in browser. Check that ConvertTo-LiteDbBSON function is not available in the workspace of the route. It will be missing in the response. image
  2. Same happens if I put Import-Module inside the Start-PodeServer's scriptblock or if I use Import-PodeModule.
  3. But it works if I Import-Module right inside the Add-PodeRoute's scriptblock. image

Expected Behavior

Function should be available if module imported before Start-PodeServer's scriptblock.

Platform

  • OS: Windows Server 2019
  • Browser: any
  • Versions:
    • Pode: 2.5.1
    • PowerShell: 7.2

Additional info

Module is installed for all users in powershell 7. image

Also noticed that on the first screenshot (when module is imported globally) it shows version 0.0.1.0. I don't have such version installed.

bug :bug: 
opened Dec 28, 2021 by MaxFalcone 21
Open

Mention the use of Maximum Worker Processes in IIS

In the IIS hosting docs, when using Sessions - or any Cookies - mention that having more than 1 Maximum Worker Process will cause issues. This is due to each worker process spinning up 2 different instances of the Pode server.

If you use a centralised sessions storage, rather than Pode's inbuilt on, this issue shouldn't occur.

documentation :book: 
opened Sep 24, 2023 by Badgerati 0
Open

Add-PodeRoute -FilePath doesn't work as expected

The expectation for Add-PodeRoute -FilePath <file.ps1> is to be equivalent to

Add-PodeRoute -ScriptBlock ([ScriptBlock]::Create( (Get-Content -Path <file.ps1> -Raw)))

but it's not the way it works

This is my test file

$Id = $WebEvent.Parameters['id'] 
Write-PodeJsonResponse -StatusCode 200 -Value @{'id' = $Id }

This one is the route: Add-PodeRoute -PassThru -Method Post -Path '/api/v1/helloFile/:id' -FilePath '.\test.ps1' | Set-PodeOARouteInfo -Summary 'Test' -OperationId 'testScriptBlock' -PassThru | Set-PodeOARequest -Parameters @((New-PodeOAStringProperty -Name 'id' | ConvertTo-PodeOAParameter -In Path) )

and this is the error that I get

InvalidOperation: C:\Users\m_dan\Documents\GitLab\cliaccess\test.ps1:1:1
Line |
   1 |  $Id = $WebEvent.Parameters['id']
     |  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     | Cannot index into a null array.

These 2 are working as expected:

Add-PodeRoute -PassThru -Method Get -Path '/api/v1/helloConvertedFile/:id' -ScriptBlock ([ScriptBlock]::Create( (Get-Content -Path '.\test.ps1' -Raw))) | Set-PodeOARouteInfo -Summary 'Test' -OperationId 'testScriptBlock' -PassThru | Set-PodeOARequest -Parameters @((New-PodeOAStringProperty -Name 'id' | ConvertTo-PodeOAParameter -In Path) )

Add-PodeRoute -PassThru -Method Get -Path '/api/v1/helloScript/:id' -ScriptBlock { $Id = $WebEvent.Parameters['id'] ; Write-PodeJsonResponse -StatusCode 200 -Value @{'id' = $Id } } | Set-PodeOARouteInfo -Summary 'Test' -OperationId 'testScriptBlock' -PassThru | Set-PodeOARequest -Parameters @((New-PodeOAStringProperty -Name 'id' | ConvertTo-PodeOAParameter -In Path) )

I think the easy way to fix this is to simply convert the file content to ScriptBlock but please let me know if I'm doing something wrong.

Pode Version: Github Develop OS Windows 11 Powershell: 7.3.7

bug :bug: 
opened Sep 24, 2023 by mdaneri 4
Open

Authentication and sessions are not working together.

Describe the Bug

Authentication and sessions are not working together. My end goal which I haven't been able to produce is to have a different session for http localhost and https local network (so anything not local requires login and https).

However, I'm hitting a discrepancy with the sessions. When I log in with https, but view the localhost http side with the same browser, it is using the same session cookie (expected), however the $webEvent.Auth structure is empty, even though Test-PodeAuthUser returns $true.

Steps To Reproduce

Import-Module pode

Start-PodeServer -ScriptBlock {
    Enable-PodeSessionMiddleware -Duration 120 -Extend -Strict -Secure

    Add-PodeEndpoint -Address * -Port 8443 -Protocol Https -SelfSigned -Name SecurePortal -Force
    Add-PodeEndpoint -Address localhost -Port 8080 -Protocol Http -Name Portal

    New-PodeAuthScheme -Basic | Add-PodeAuthWindowsLocal -Name 'Login' -Users testUser

    $sb = {
        Write-PodeJsonResponse @{
            IsAuthenticated = Test-PodeAuthUser
            Auth = $webEvent.Auth
        }
    }

    Add-PodeRoute -Path '/' -Method Get -EndpointName Portal -AllowAnon -ScriptBlock $sb
    Add-PodeRoute -Path '/' -Method Get -EndpointName SecurePortal -Authentication Login -ScriptBlock $sb
}

Observed Behavior

Initial load of http://localhost:8080/

{
  "Auth": {

  },
  "IsAuthenticated": false
}

Initial load & successful authentication of https://localhost:8443/

{
  "Auth": {
    "Store": true,
    "User": {
      "Username": "testUser",
      "Fqdn": "xxxxx",
      "UserType": "Local",
      "Name": "",
      "Groups": [
        "Users"
      ],
      "AuthenticationType": "WinNT",
      "Domain": "localhost"
    },
    "IsAuthenticated": true
  },
  "IsAuthenticated": true
}

Re-visit http://localhost:8080/ - $webEvent.Auth structure is empty, even though Test-PodeAuthUser returns $true.

{
  "Auth": {

  },
  "IsAuthenticated": true
}

Expected behavior

If Test-PodeAuthUser returns true, I'd expect the $webEvent.Auth to be populated.

Platform

  • OS: Windows 10
  • Browser: chrome
  • Versions:
    • Pode: 2.8
    • PowerShell: 5.1, 7.3.x
enhancement :arrow_up: 
opened Sep 24, 2023 by Chris--A 2
Open

JWT expired Bearer token return 400 - RFC6750 demand 401

Based on the RFC https://www.rfc-editor.org/rfc/rfc6750 an expired bearer token should return 401 not 400

private/Authentication.ps1 line 429

 if ($options.AsJWT) {
            try {
                $payload = ConvertFrom-PodeJwt -Token $token -Secret $options.Secret
                Test-PodeJwt -Payload $payload
            }
            catch {
                if ($_.Exception.Message -ilike '*jwt*') {
                    return @{
                        Message = $_.Exception.Message
                        Code = 400
                    }
                }

                throw
            } 
            $result = @($payload)
        }

should be changed to

     if ($options.AsJWT) {
            try {
                $payload = ConvertFrom-PodeJwt -Token $token -Secret $options.Secret
                Test-PodeJwt -Payload $payload
            }
            catch {
                if ($_.Exception.Message -ilike '*jwt*') {
                    return @{
                        Message = $_.Exception.Message
                        #https://www.rfc-editor.org/rfc/rfc6750 Bearer token should return 401
                        Challenge = (New-PodeAuthBearerChallenge -Scopes $options.Scopes -ErrorType invalid_token) 
                        Code = 401
                    }
                } 
                throw
            } 
            $result = @($payload)
        }
bug :bug: 
opened Sep 21, 2023 by mdaneri 1
Open

Runspace error on pode start

Describe the Bug

Failed to close RunspacePool: Main error on running pode start

Steps To Reproduce

Steps to reproduce the behavior: create a simple server.ps1 witht he following content:

Start-PodeServer {
    New-PodeLoggingMethod -Terminal | Enable-PodeErrorLogging
    Write-Host 'hello, world!'
}

run pode start

Expected Behavior

hello world is print with no error

Screenshots

image

Platform

  • Windows
  • Chrome,edge,firefox
  • Versions:
    • Pode 2.8.0
    • Pwsh 7.3.6

Additional Context

Also tried with an older version of pode, tried another user account, different content in server.ps1

bug :bug: 
opened Sep 21, 2023 by v2kiran 3
Open

OpenAPI full compliance

Description of the Change

I rewrite big part of the OpenAPI public and private

Related Issue

1128 ,1131

Examples

I made any changes required to create the PetShop sample

Additional Context

I added a full Petstore sample there you can see all new features that I added to the library

opened Aug 31, 2023 by mdaneri 2

Contents

    kz26 mailproxy is a simple SMTP proxy. It receives emails through an unencrypted, unauthenticated SMTP interface and retransmits them through a remote SMTP server that requires modern features such as encryption and/or authentication. mailproxy is primarily useful for enabling email functionality in legacy software that only supports plain SMTP.
    mailhog MailHog SMTP Protocol
    Rvn0xsy SMTP Netcat , test SMTP protocol
    praetorian-inc PortBender is a TCP port redirection utility that allows a red team operator to redirect inbound traffic destined for one TCP port
    nodemailer ✉️ Send e-mails with Node.JS – easy as cake!
    async-email async-smtp - SMTP client
    vector-sec AWS PowerShell Python Lambda, or PSPy for short, is a simple Python 2.7 AWS Lambda function designed to execute the PowerShell binary and marshal input/output to PowerShell.
    Badgerati 2D game framework for use with the Pode PowerShell web server
    zedshaw Pythonic SMTP Application Server
    orkunkaraduman Go TCP Server library
    sumeetchhetri Framework for Enterprise Application Development, webrtc signalling server, peerjs webrtc, c++ framework, c++ web framework, c++ application framework, c++ rest framework, c++ soap framework, c++ web sites, c++ web applications, c++ driven web development - c++
    MengRao A Tcp/Ip stack implementation on top of Solarflare ef_vi, and a C++ headers only framework for tcp multiplexing client/server.
    linkedin Rest.li is a REST+JSON framework for building robust, scalable service architectures using dynamic discovery and simple asynchronous APIs.
    PowerShell PowerShell for every system!
    spapas A mailer server; use your smtp server to allow your users to send mass emails and provide an HTTP email API
    billzhong Python SMTP Server for Humans
    smancke golang library for smtp based email validation
    alash3al a tiny package that implements SMTP server for Go projects
    onevcat Send email to any SMTP server like a boss, in Swift and cross-platform
    babelouest Web Framework to build REST APIs, Webservices or any HTTP endpoint in C language. Can stream large amount of data, integrate JSON data with Jansson, and create websocket services
    postalsys Self hosted application to access IMAP and SMTP accounts over REST
    Share this repo

    Related Repos


    Web Frameworks
    3.2k
    A better way to create web api endpoints for ASP.Net 6 that encourages CQRS and Vertical S...
    FastEndpoints A better way to create web api endpoints for ASP.Net 6 that encourages CQRS and Vertical Slice Architecture.
     
    Web Frameworks
    2.7k
    A project for supporting API Endpoints in ASP.NET Core web applications.
    ardalis A project for supporting API Endpoints in ASP.NET Core web applications.
     
    Web Frameworks
    44
    Open Source / i18n / Cross Platform Contact Tracing App by exposure notification framework...
    Covid-19Radar Open Source / i18n / Cross Platform Contact Tracing App by exposure notification framework.
     
    Web Frameworks
    690
    Pode is a Cross-Platform PowerShell web framework for creating REST APIs, Web Sites, and T...
    Badgerati Pode Pode is a Cross-Platform framework, completely written in PowerShell, for creating web servers to host REST APIs, Web Pages, and SMTP/TCP Servers. Pode also allows you to render dynamic files using .pode files,
     
    Web Frameworks
    1.5k
    Modular Application Framework for Blazor
    oqtane Oqtane Framework Oqtane is a Modular Application Framework for Blazor Oqtane uses Blazor, a new web framework for .NET Core that lets you build interactive web UIs using C# instead of JavaScript. Blazor apps are composed of re
     
    Web Frameworks
    1.5k
    Modular Application Framework for Blazor
    oqtane Oqtane Framework Oqtane is a Modular Application Framework for Blazor Oqtane uses Blazor, a new web framework for .NET Core that lets you build interactive web UIs using C# instead of JavaScript. Blazor apps are composed of re
     
    Web Frameworks
    3.2k
    Blazor workshop
    dotnet-presentations Blazor - app building workshop Welcome to the Blazor app building workshop! Blazor is a single-page app framework for building client-side web apps using .NET and WebAssembly. In this workshop we will build a complete Blazor app
     
    Web Frameworks
    497
    A cross-platform, minimalist web framework for PowerShell
    PowerShell Polaris A cross-platform, minimalist web framework for PowerShell. Disclaimer Polaris is currently an unsupported, experimental, proof-of-concept. There is no current plan to turn it into a supported Microsoft pro
     
    Web Frameworks
    1.5k
    Microdot: An open source .NET microservices framework
    gigya Microdot Framework An open source .NET microservices framework Microdot is an open source .NET framework that answers a lot of the needs for easily creating microservices. Some of its main features: Service contai
     
    Popular
    Web Frameworks
    11.3k
    ASP.NET Boilerplate - Web Application Framework
    aspnetboilerplate ASP.NET Boilerplate AppVeyor: What is ABP? ASP.NET Boilerplate is a general purpose application framework especially designed for new modern web applications. It uses already familiar tools and implements best practi
     
    Web Frameworks
    480
    A flexible web framework supports .Net Framework and .Net Core
    zkweb-framework ZKWeb ZKWeb is a flexible web framework for .NET Framework and .NET Core. Why created this framework? I want a better plugin system, one folder one plugin just like django I want an independent mvc framework, because