Make csrf token available in PluginTemplateExtension #3695

New Issue

adam · 2025-12-29T18:30:39+01:00

adam commented

2025-12-29 18:30:39 +01:00

Originally created by @steffann on GitHub (May 16, 2020).

Originally assigned to: @steffann on GitHub.

Environment

Python version: 3.7.6
NetBox version: 2.8.4

Proposed Functionality

Currently each PluginTemplateExtension is provided a context containing object, requests, settings and config. I propose to add csrf_token to the default context.

Use Case

Writers of plugins may want to include a POST form in their template extension. This could be as simple a button for triggering or updating something. Basically for anything that has side-effects should not use GET.

A work-around is:

from django.template.context_processors import csrf

def left_page(self):
   context = {
       'abc': 'xyz',
   }
   context.update(csrf(self.context['request']))
   return self.render('pluginname/test.html', context)

My feeling is that this shouldn't be necessary and that NetBox should provide the csrf_token by default.

Database Changes

None

External Dependencies

None

Originally created by @steffann on GitHub (May 16, 2020). Originally assigned to: @steffann on GitHub. ### Environment * Python version: 3.7.6 * NetBox version: 2.8.4 ### Proposed Functionality Currently each `PluginTemplateExtension` is provided a context containing `object`, `requests`, `settings` and `config`. I propose to add `csrf_token` to the default context. ### Use Case Writers of plugins may want to include a POST form in their template extension. This could be as simple a button for triggering or updating something. Basically for anything that has side-effects should not use GET. A work-around is: ``` from django.template.context_processors import csrf def left_page(self): context = { 'abc': 'xyz', } context.update(csrf(self.context['request'])) return self.render('pluginname/test.html', context) ``` My feeling is that this shouldn't be necessary and that NetBox should provide the `csrf_token` by default. ### Database Changes None ### External Dependencies None

adam added the status: accepted label 2025-12-29 18:30:39 +01:00

adam closed this issue

2025-12-29 18:30:39 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#3695