checks.txt 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571
  1. ======================
  2. System check framework
  3. ======================
  4. .. currentmodule:: django.core.checks
  5. The system check framework is a set of static checks for validating Django
  6. projects. It detects common problems and provides hints for how to fix them.
  7. The framework is extensible so you can easily add your own checks.
  8. For details on how to add your own checks and integrate them with Django's
  9. system checks, see the :doc:`System check topic guide </topics/checks>`.
  10. API Reference
  11. =============
  12. ``CheckMessage``
  13. -----------------
  14. .. class:: CheckMessage(level, msg, hint, obj=None, id=None)
  15. The warnings and errors raised by system checks must be instances of
  16. ``CheckMessage``. An instance encapsulates a single reportable error or
  17. warning. It also provides context and hints applicable to the message, and a
  18. unique identifier that is used for filtering purposes.
  19. Constructor arguments are:
  20. ``level``
  21. The severity of the message. Use one of the predefined values: ``DEBUG``,
  22. ``INFO``, ``WARNING``, ``ERROR``, ``CRITICAL``. If the level is greater or
  23. equal to ``ERROR``, then Django will prevent management commands from
  24. executing. Messages with level lower than ``ERROR`` (i.e. warnings) are
  25. reported to the console, but can be silenced.
  26. ``msg``
  27. A short (less than 80 characters) string describing the problem. The string
  28. should *not* contain newlines.
  29. ``hint``
  30. A single-line string providing a hint for fixing the problem. If no hint
  31. can be provided, or the hint is self-evident from the error message, the
  32. hint can be omitted, or a value of ``None`` can be used.
  33. ``obj``
  34. Optional. An object providing context for the message (for example, the
  35. model where the problem was discovered). The object should be a model,
  36. field, or manager or any other object that defines ``__str__`` method (on
  37. Python 2 you need to define ``__unicode__`` method). The method is used
  38. while reporting all messages and its result precedes the message.
  39. ``id``
  40. Optional string. A unique identifier for the issue. Identifiers should
  41. follow the pattern ``applabel.X001``, where ``X`` is one of the letters
  42. ``CEWID``, indicating the message severity (``C`` for criticals, ``E`` for
  43. errors and so). The number can be allocated by the application, but should
  44. be unique within that application.
  45. There are subclasses to make creating messages with common levels easier. When
  46. using them you can omit the ``level`` argument because it is implied by the
  47. class name.
  48. .. class:: Debug(msg, hint, obj=None, id=None)
  49. .. class:: Info(msg, hint, obj=None, id=None)
  50. .. class:: Warning(msg, hint, obj=None, id=None)
  51. .. class:: Error(msg, hint, obj=None, id=None)
  52. .. class:: Critical(msg, hint, obj=None, id=None)
  53. Builtin checks
  54. ==============
  55. Builtin tags
  56. ------------
  57. Django's system checks are organized using the following tags:
  58. * ``models``: Checks governing model, field and manager definitions.
  59. * ``signals``: Checks on signal declarations and handler registrations.
  60. * ``admin``: Checks of any admin site declarations.
  61. * ``compatibility``: Flagging potential problems with version upgrades.
  62. * ``security``: Checks security related configuration.
  63. * ``templates``: Checks template related configuration.
  64. Some checks may be registered with multiple tags.
  65. Core system checks
  66. ------------------
  67. Models
  68. ~~~~~~
  69. * **models.E001**: ``<swappable>`` is not of the form ``app_label.app_name``.
  70. * **models.E002**: ``<SETTING>`` references ``<model>``, which has not been
  71. installed, or is abstract.
  72. * **models.E003**: The model has two many-to-many relations through the
  73. intermediate model ``<app_label>.<model>``.
  74. * **models.E004**: ``id`` can only be used as a field name if the field also
  75. sets ``primary_key=True``.
  76. * **models.E005**: The field ``<field name>`` from parent model ``<model>``
  77. clashes with the field ``<field name>`` from parent model ``<model>``.
  78. * **models.E006**: The field clashes with the field ``<field name>`` from model
  79. ``<model>``.
  80. * **models.E007**: Field ``<field name>`` has column name ``<column name>``
  81. that is used by another field.
  82. * **models.E008**: ``index_together`` must be a list or tuple.
  83. * **models.E009**: All ``index_together`` elements must be lists or tuples.
  84. * **models.E010**: ``unique_together`` must be a list or tuple.
  85. * **models.E011**: All ``unique_together`` elements must be lists or tuples.
  86. * **models.E012**: ``index_together/unique_together`` refers to the
  87. non-existent field ``<field name>``.
  88. * **models.E013**: ``index_together/unique_together`` refers to a
  89. ``ManyToManyField`` ``<field name>``, but ``ManyToManyField``\s are not
  90. supported for that option.
  91. * **models.E014**: ``ordering`` must be a tuple or list (even if you want to
  92. order by only one field).
  93. * **models.E015**: ``ordering`` refers to the non-existent field
  94. ``<field name>``.
  95. * **models.E016**: ``index_together/unique_together`` refers to field
  96. ``<field_name>`` which is not local to model ``<model>``.
  97. * **models.E017**: Proxy model ``<model>`` contains model fields.
  98. * **models.E018**: Autogenerated column name too long for field ``<field>``.
  99. Maximum length is ``<maximum length>`` for database ``<alias>``.
  100. * **models.E019**: Autogenerated column name too long for M2M field
  101. ``<M2M field>``. Maximum length is ``<maximum length>`` for database
  102. ``<alias>``.
  103. * **models.E020**: The ``<model>.check()`` class method is currently overridden.
  104. * **models.E021**: ``ordering`` and ``order_with_respect_to`` cannot be used
  105. together.
  106. Fields
  107. ~~~~~~
  108. * **fields.E001**: Field names must not end with an underscore.
  109. * **fields.E002**: Field names must not contain ``"__"``.
  110. * **fields.E003**: ``pk`` is a reserved word that cannot be used as a field
  111. name.
  112. * **fields.E004**: ``choices`` must be an iterable (e.g., a list or tuple).
  113. * **fields.E005**: ``choices`` must be an iterable returning ``(actual value,
  114. human readable name)`` tuples.
  115. * **fields.E006**: ``db_index`` must be ``None``, ``True`` or ``False``.
  116. * **fields.E007**: Primary keys must not have ``null=True``.
  117. * **fields.E100**: ``AutoField``\s must set primary_key=True.
  118. * **fields.E110**: ``BooleanField``\s do not accept null values.
  119. * **fields.E120**: ``CharField``\s must define a ``max_length`` attribute.
  120. * **fields.E121**: ``max_length`` must be a positive integer.
  121. * **fields.W122**: ``max_length`` is ignored when used with ``IntegerField``.
  122. * **fields.E130**: ``DecimalField``\s must define a ``decimal_places`` attribute.
  123. * **fields.E131**: ``decimal_places`` must be a non-negative integer.
  124. * **fields.E132**: ``DecimalField``\s must define a ``max_digits`` attribute.
  125. * **fields.E133**: ``max_digits`` must be a non-negative integer.
  126. * **fields.E134**: ``max_digits`` must be greater or equal to ``decimal_places``.
  127. * **fields.E140**: ``FilePathField``\s must have either ``allow_files`` or
  128. ``allow_folders`` set to True.
  129. * **fields.E150**: ``GenericIPAddressField``\s cannot accept blank values if
  130. null values are not allowed, as blank values are stored as nulls.
  131. * **fields.E160**: The options ``auto_now``, ``auto_now_add``, and ``default``
  132. are mutually exclusive. Only one of these options may be present.
  133. * **fields.W161**: Fixed default value provided.
  134. * **fields.E900**: ``IPAddressField`` has been removed except for support in
  135. historical migrations.
  136. * **fields.W900**: ``IPAddressField`` has been deprecated. Support for it
  137. (except in historical migrations) will be removed in Django 1.9. *This check
  138. appeared in Django 1.7 and 1.8*.
  139. File Fields
  140. ~~~~~~~~~~~
  141. * **fields.E200**: ``unique`` is not a valid argument for a ``FileField``.
  142. * **fields.E201**: ``primary_key`` is not a valid argument for a ``FileField``.
  143. * **fields.E210**: Cannot use ``ImageField`` because Pillow is not installed.
  144. Related Fields
  145. ~~~~~~~~~~~~~~
  146. * **fields.E300**: Field defines a relation with model ``<model>``, which is
  147. either not installed, or is abstract.
  148. * **fields.E301**: Field defines a relation with the model ``<model>`` which
  149. has been swapped out.
  150. * **fields.E302**: Accessor for field ``<field name>`` clashes with field
  151. ``<field name>``.
  152. * **fields.E303**: Reverse query name for field ``<field name>`` clashes with
  153. field ``<field name>``.
  154. * **fields.E304**: Field name ``<field name>`` clashes with accessor for
  155. ``<field name>``.
  156. * **fields.E305**: Field name ``<field name>`` clashes with reverse query name
  157. for ``<field name>``.
  158. * **fields.E306**: Related name must be a valid Python identifier or end with
  159. a ``'+'``.
  160. * **fields.E310**: None of the fields ``<field1>``, ``<field2>``, ... on model
  161. ``<model>`` have a ``unique=True`` constraint.
  162. * **fields.E311**: ``<model>`` must set ``unique=True`` because it is
  163. referenced by a ``ForeignKey``.
  164. * **fields.E320**: Field specifies ``on_delete=SET_NULL``, but cannot be null.
  165. * **fields.E321**: The field specifies ``on_delete=SET_DEFAULT``, but has no
  166. default value.
  167. * **fields.E330**: ``ManyToManyField``\s cannot be unique.
  168. * **fields.E331**: Field specifies a many-to-many relation through model
  169. ``<model>``, which has not been installed.
  170. * **fields.E332**: Many-to-many fields with intermediate tables must not be
  171. symmetrical.
  172. * **fields.E333**: The model is used as an intermediate model by ``<model>``,
  173. but it has more than two foreign keys to ``<model>``, which is ambiguous.
  174. You must specify which two foreign keys Django should use via the
  175. ``through_fields`` keyword argument.
  176. * **fields.E334**: The model is used as an intermediate model by ``<model>``,
  177. but it has more than one foreign key from ``<model>``, which is ambiguous.
  178. You must specify which foreign key Django should use via the
  179. ``through_fields`` keyword argument.
  180. * **fields.E335**: The model is used as an intermediate model by ``<model>``,
  181. but it has more than one foreign key to ``<model>``, which is ambiguous.
  182. You must specify which foreign key Django should use via the
  183. ``through_fields`` keyword argument.
  184. * **fields.E336**: The model is used as an intermediary model by ``<model>``,
  185. but it does not have foreign key to ``<model>`` or ``<model>``.
  186. * **fields.E337**: Field specifies ``through_fields`` but does not provide the
  187. names of the two link fields that should be used for the relation through
  188. ``<model>``.
  189. * **fields.E338**: The intermediary model ``<through model>`` has no field
  190. ``<field name>``.
  191. * **fields.E339**: ``<model>.<field name>`` is not a foreign key to ``<model>``.
  192. * **fields.W340**: ``null`` has no effect on ``ManyToManyField``.
  193. * **fields.W341**: ``ManyToManyField`` does not support ``validators``.
  194. * **fields.W342**: Setting ``unique=True`` on a ``ForeignKey`` has the same
  195. effect as using a ``OneToOneField``.
  196. Signals
  197. ~~~~~~~
  198. * **signals.E001**: ``<handler>`` was connected to the ``<signal>`` signal with
  199. a lazy reference to the ``<model>`` sender, which has not been installed.
  200. Backwards Compatibility
  201. ~~~~~~~~~~~~~~~~~~~~~~~
  202. The following checks are performed to warn the user of any potential problems
  203. that might occur as a result of a version upgrade.
  204. * **1_6.W001**: Some project unit tests may not execute as expected. *This
  205. check was removed in Django 1.8 due to false positives*.
  206. * **1_6.W002**: ``BooleanField`` does not have a default value. *This
  207. check was removed in Django 1.8 due to false positives*.
  208. * **1_7.W001**: Django 1.7 changed the global defaults for the
  209. ``MIDDLEWARE_CLASSES.``
  210. ``django.contrib.sessions.middleware.SessionMiddleware``,
  211. ``django.contrib.auth.middleware.AuthenticationMiddleware``, and
  212. ``django.contrib.messages.middleware.MessageMiddleware`` were removed from
  213. the defaults. If your project needs these middleware then you should
  214. configure this setting. *This check was removed in Django 1.9*.
  215. * **1_8.W001**: The standalone ``TEMPLATE_*`` settings were deprecated in
  216. Django 1.8 and the :setting:`TEMPLATES` dictionary takes precedence. You must
  217. put the values of the following settings into your defaults ``TEMPLATES``
  218. dict: :setting:`TEMPLATE_DIRS`, :setting:`ALLOWED_INCLUDE_ROOTS`,
  219. :setting:`TEMPLATE_CONTEXT_PROCESSORS`, :setting:`TEMPLATE_DEBUG`,
  220. :setting:`TEMPLATE_LOADERS`, :setting:`TEMPLATE_STRING_IF_INVALID`.
  221. Admin
  222. -----
  223. Admin checks are all performed as part of the ``admin`` tag.
  224. The following checks are performed on any
  225. :class:`~django.contrib.admin.ModelAdmin` (or subclass) that is registered
  226. with the admin site:
  227. * **admin.E001**: The value of ``raw_id_fields`` must be a list or tuple.
  228. * **admin.E002**: The value of ``raw_id_fields[n]`` refers to ``<field name>``,
  229. which is not an attribute of ``<model>``.
  230. * **admin.E003**: The value of ``raw_id_fields[n]`` must be a ``ForeignKey`` or
  231. ``ManyToManyField``.
  232. * **admin.E004**: The value of ``fields`` must be a list or tuple.
  233. * **admin.E005**: Both ``fieldsets`` and ``fields`` are specified.
  234. * **admin.E006**: The value of ``fields`` contains duplicate field(s).
  235. * **admin.E007**: The value of ``fieldsets`` must be a list or tuple.
  236. * **admin.E008**: The value of ``fieldsets[n]`` must be a list or tuple.
  237. * **admin.E009**: The value of ``fieldsets[n]`` must be of length 2.
  238. * **admin.E010**: The value of ``fieldsets[n][1]`` must be a dictionary.
  239. * **admin.E011**: The value of ``fieldsets[n][1]`` must contain the key
  240. ``fields``.
  241. * **admin.E012**: There are duplicate field(s) in ``fieldsets[n][1]``.
  242. * **admin.E013**: ``fields[n]/fieldsets[n][m]`` cannot include the
  243. ``ManyToManyField`` ``<field name>``, because that field manually specifies a
  244. relationship model.
  245. * **admin.E014**: The value of ``exclude`` must be a list or tuple.
  246. * **admin.E015**: The value of ``exclude`` contains duplicate field(s).
  247. * **admin.E016**: The value of ``form`` must inherit from ``BaseModelForm``.
  248. * **admin.E017**: The value of ``filter_vertical`` must be a list or tuple.
  249. * **admin.E018**: The value of ``filter_horizontal`` must be a list or tuple.
  250. * **admin.E019**: The value of ``filter_vertical[n]/filter_vertical[n]`` refers
  251. to ``<field name>``, which is not an attribute of ``<model>``.
  252. * **admin.E020**: The value of ``filter_vertical[n]/filter_vertical[n]`` must
  253. be a ``ManyToManyField``.
  254. * **admin.E021**: The value of ``radio_fields`` must be a dictionary.
  255. * **admin.E022**: The value of ``radio_fields`` refers to ``<field name>``,
  256. which is not an attribute of ``<model>``.
  257. * **admin.E023**: The value of ``radio_fields`` refers to ``<field name>``,
  258. which is not a ``ForeignKey``, and does not have a ``choices`` definition.
  259. * **admin.E024**: The value of ``radio_fields[<field name>]`` must be either
  260. ``admin.HORIZONTAL`` or ``admin.VERTICAL``.
  261. * **admin.E025**: The value of ``view_on_site`` must be either a callable or a
  262. boolean value.
  263. * **admin.E026**: The value of ``prepopulated_fields`` must be a dictionary.
  264. * **admin.E027**: The value of ``prepopulated_fields`` refers to
  265. ``<field name>``, which is not an attribute of ``<model>``.
  266. * **admin.E028**: The value of ``prepopulated_fields`` refers to
  267. ``<field name>``, which must not be a ``DateTimeField``, ``ForeignKey`` or
  268. ``ManyToManyField``.
  269. * **admin.E029**: The value of ``prepopulated_fields[<field name>]`` must be a
  270. list or tuple.
  271. * **admin.E030**: The value of ``prepopulated_fields`` refers to
  272. ``<field name>``, which is not an attribute of ``<model>``.
  273. * **admin.E031**: The value of ``ordering`` must be a list or tuple.
  274. * **admin.E032**: The value of ``ordering`` has the random ordering marker
  275. ``?``, but contains other fields as well.
  276. * **admin.E033**: The value of ``ordering`` refers to ``<field name>``, which
  277. is not an attribute of ``<model>``.
  278. * **admin.E034**: The value of ``readonly_fields`` must be a list or tuple.
  279. * **admin.E035**: The value of ``readonly_fields[n]`` is not a callable, an
  280. attribute of ``<ModelAdmin class>``, or an attribute of ``<model>``.
  281. ModelAdmin
  282. ~~~~~~~~~~
  283. The following checks are performed on any
  284. :class:`~django.contrib.admin.ModelAdmin` that is registered
  285. with the admin site:
  286. * **admin.E101**: The value of ``save_as`` must be a boolean.
  287. * **admin.E102**: The value of ``save_on_top`` must be a boolean.
  288. * **admin.E103**: The value of ``inlines`` must be a list or tuple.
  289. * **admin.E104**: ``<InlineModelAdmin class>`` must inherit from
  290. ``BaseModelAdmin``.
  291. * **admin.E105**: ``<InlineModelAdmin class>`` must have a ``model`` attribute.
  292. * **admin.E106**: The value of ``<InlineModelAdmin class>.model`` must be a
  293. ``Model``.
  294. * **admin.E107**: The value of ``list_display`` must be a list or tuple.
  295. * **admin.E108**: The value of ``list_display[n]`` refers to ``<label>``,
  296. which is not a callable, an attribute of ``<ModelAdmin class>``, or an
  297. attribute or method on ``<model>``.
  298. * **admin.E109**: The value of ``list_display[n]`` must not be a
  299. ``ManyToManyField``.
  300. * **admin.E110**: The value of ``list_display_links`` must be a list, a tuple,
  301. or ``None``.
  302. * **admin.E111**: The value of ``list_display_links[n]`` refers to ``<label>``,
  303. which is not defined in ``list_display``.
  304. * **admin.E112**: The value of ``list_filter`` must be a list or tuple.
  305. * **admin.E113**: The value of ``list_filter[n]`` must inherit from
  306. ``ListFilter``.
  307. * **admin.E114**: The value of ``list_filter[n]`` must not inherit from
  308. ``FieldListFilter``.
  309. * **admin.E115**: The value of ``list_filter[n][1]`` must inherit from
  310. ``FieldListFilter``.
  311. * **admin.E116**: The value of ``list_filter[n]`` refers to ``<label>``,
  312. which does not refer to a Field.
  313. * **admin.E117**: The value of ``list_select_related`` must be a boolean,
  314. tuple or list.
  315. * **admin.E118**: The value of ``list_per_page`` must be an integer.
  316. * **admin.E119**: The value of ``list_max_show_all`` must be an integer.
  317. * **admin.E120**: The value of ``list_editable`` must be a list or tuple.
  318. * **admin.E121**: The value of ``list_editable[n]`` refers to ``<label>``,
  319. which is not an attribute of ``<model>``.
  320. * **admin.E122**: The value of ``list_editable[n]`` refers to ``<label>``,
  321. which is not contained in ``list_display``.
  322. * **admin.E123**: The value of ``list_editable[n]`` cannot be in both
  323. ``list_editable`` and ``list_display_links``.
  324. * **admin.E124**: The value of ``list_editable[n]`` refers to the first field
  325. in ``list_display`` (``<label>``), which cannot be used unless
  326. ``list_display_links`` is set.
  327. * **admin.E125**: The value of ``list_editable[n]`` refers to ``<field name>``,
  328. which is not editable through the admin.
  329. * **admin.E126**: The value of ``search_fields`` must be a list or tuple.
  330. * **admin.E127**: The value of ``date_hierarchy`` refers to ``<field name>``,
  331. which is not an attribute of ``<model>``.
  332. * **admin.E128**: The value of ``date_hierarchy`` must be a ``DateField`` or
  333. ``DateTimeField``.
  334. InlineModelAdmin
  335. ~~~~~~~~~~~~~~~~
  336. The following checks are performed on any
  337. :class:`~django.contrib.admin.InlineModelAdmin` that is registered as an
  338. inline on a :class:`~django.contrib.admin.ModelAdmin`.
  339. * **admin.E201**: Cannot exclude the field ``<field name>``, because it is the
  340. foreign key to the parent model ``<app_label>.<model>``.
  341. * **admin.E202**: ``<model>`` has no ``ForeignKey`` to ``<parent model>``./
  342. ``<model>`` has more than one ``ForeignKey`` to ``<parent model>``.
  343. * **admin.E203**: The value of ``extra`` must be an integer.
  344. * **admin.E204**: The value of ``max_num`` must be an integer.
  345. * **admin.E205**: The value of ``min_num`` must be an integer.
  346. * **admin.E206**: The value of ``formset`` must inherit from
  347. ``BaseModelFormSet``.
  348. GenericInlineModelAdmin
  349. ~~~~~~~~~~~~~~~~~~~~~~~
  350. The following checks are performed on any
  351. :class:`~django.contrib.contenttypes.admin.GenericInlineModelAdmin` that is
  352. registered as an inline on a :class:`~django.contrib.admin.ModelAdmin`.
  353. * **admin.E301**: ``'ct_field'`` references ``<label>``, which is not a field
  354. on ``<model>``.
  355. * **admin.E302**: ``'ct_fk_field'`` references ``<label>``, which is not a
  356. field on ``<model>``.
  357. * **admin.E303**: ``<model>`` has no ``GenericForeignKey``.
  358. * **admin.E304**: ``<model>`` has no ``GenericForeignKey`` using content type
  359. field ``<field name>`` and object ID field ``<field name>``.
  360. Auth
  361. ----
  362. * **auth.E001**: ``REQUIRED_FIELDS`` must be a list or tuple.
  363. * **auth.E002**: The field named as the ``USERNAME_FIELD`` for a custom user
  364. model must not be included in ``REQUIRED_FIELDS``.
  365. * **auth.E003**: ``<field>`` must be unique because it is named as the
  366. ``USERNAME_FIELD``.
  367. * **auth.W004**: ``<field>`` is named as the ``USERNAME_FIELD``, but it is not
  368. unique.
  369. Content Types
  370. -------------
  371. The following checks are performed when a model contains a
  372. :class:`~django.contrib.contenttypes.fields.GenericForeignKey` or
  373. :class:`~django.contrib.contenttypes.fields.GenericRelation`:
  374. * **contenttypes.E001**: The ``GenericForeignKey`` object ID references the
  375. non-existent field ``<field>``.
  376. * **contenttypes.E002**: The ``GenericForeignKey`` content type references the
  377. non-existent field ``<field>``.
  378. * **contenttypes.E003**: ``<field>`` is not a ``ForeignKey``.
  379. * **contenttypes.E004**: ``<field>`` is not a ``ForeignKey`` to
  380. ``contenttypes.ContentType``.
  381. Security
  382. --------
  383. The security checks do not make your site secure. They do not audit code, do
  384. intrusion detection, or do anything particularly complex. Rather, they help
  385. perform an automated, low-hanging-fruit checklist. They help you remember the
  386. simple things that improve your site's security.
  387. Some of these checks may not be appropriate for your particular deployment
  388. configuration. For instance, if you do your HTTP to HTTPS redirection in a load
  389. balancer, it'd be irritating to be constantly warned about not having enabled
  390. :setting:`SECURE_SSL_REDIRECT`. Use :setting:`SILENCED_SYSTEM_CHECKS` to
  391. silence unneeded checks.
  392. The following checks will be run if you use the :djadminopt:`--deploy` option
  393. of the :djadmin:`check` command:
  394. * **security.W001**: You do not have
  395. :class:`django.middleware.security.SecurityMiddleware` in your
  396. :setting:`MIDDLEWARE_CLASSES` so the :setting:`SECURE_HSTS_SECONDS`,
  397. :setting:`SECURE_CONTENT_TYPE_NOSNIFF`, :setting:`SECURE_BROWSER_XSS_FILTER`,
  398. and :setting:`SECURE_SSL_REDIRECT` settings will have no effect.
  399. * **security.W002**: You do not have
  400. :class:`django.middleware.clickjacking.XFrameOptionsMiddleware` in your
  401. :setting:`MIDDLEWARE_CLASSES`, so your pages will not be served with an
  402. ``'x-frame-options'`` header. Unless there is a good reason for your
  403. site to be served in a frame, you should consider enabling this
  404. header to help prevent clickjacking attacks.
  405. * **security.W003**: You don't appear to be using Django's built-in cross-site
  406. request forgery protection via the middleware
  407. (:class:`django.middleware.csrf.CsrfViewMiddleware` is not in your
  408. :setting:`MIDDLEWARE_CLASSES`). Enabling the middleware is the safest
  409. approach to ensure you don't leave any holes.
  410. * **security.W004**: You have not set a value for the
  411. :setting:`SECURE_HSTS_SECONDS` setting. If your entire site is served only
  412. over SSL, you may want to consider setting a value and enabling :ref:`HTTP
  413. Strict Transport Security <http-strict-transport-security>`. Be sure to read
  414. the documentation first; enabling HSTS carelessly can cause serious,
  415. irreversible problems.
  416. * **security.W005**: You have not set the
  417. :setting:`SECURE_HSTS_INCLUDE_SUBDOMAINS` setting to ``True``. Without this,
  418. your site is potentially vulnerable to attack via an insecure connection to a
  419. subdomain. Only set this to ``True`` if you are certain that all subdomains of
  420. your domain should be served exclusively via SSL.
  421. * **security.W006**: Your :setting:`SECURE_CONTENT_TYPE_NOSNIFF` setting is not
  422. set to ``True``, so your pages will not be served with an
  423. ``'x-content-type-options: nosniff'`` header. You should consider enabling
  424. this header to prevent the browser from identifying content types incorrectly.
  425. * **security.W007**: Your :setting:`SECURE_BROWSER_XSS_FILTER` setting is not
  426. set to ``True``, so your pages will not be served with an
  427. ``'x-xss-protection: 1; mode=block'`` header. You should consider enabling
  428. this header to activate the browser's XSS filtering and help prevent XSS
  429. attacks.
  430. * **security.W008**: Your :setting:`SECURE_SSL_REDIRECT` setting is not set to
  431. ``True``. Unless your site should be available over both SSL and non-SSL
  432. connections, you may want to either set this setting to ``True`` or configure
  433. a load balancer or reverse-proxy server to redirect all connections to HTTPS.
  434. * **security.W009**: Your :setting:`SECRET_KEY` has less than 50 characters or
  435. less than 5 unique characters. Please generate a long and random
  436. ``SECRET_KEY``, otherwise many of Django's security-critical features will be
  437. vulnerable to attack.
  438. * **security.W010**: You have :mod:`django.contrib.sessions` in your
  439. :setting:`INSTALLED_APPS` but you have not set
  440. :setting:`SESSION_COOKIE_SECURE` to ``True``. Using a secure-only session
  441. cookie makes it more difficult for network traffic sniffers to hijack user
  442. sessions.
  443. * **security.W011**: You have
  444. :class:`django.contrib.sessions.middleware.SessionMiddleware` in your
  445. :setting:`MIDDLEWARE_CLASSES`, but you have not set
  446. :setting:`SESSION_COOKIE_SECURE` to ``True``. Using a secure-only session
  447. cookie makes it more difficult for network traffic sniffers to hijack user
  448. sessions.
  449. * **security.W012**: :setting:`SESSION_COOKIE_SECURE` is not set to ``True``.
  450. Using a secure-only session cookie makes it more difficult for network traffic
  451. sniffers to hijack user sessions.
  452. * **security.W013**: You have :mod:`django.contrib.sessions` in your
  453. :setting:`INSTALLED_APPS`, but you have not set
  454. :setting:`SESSION_COOKIE_HTTPONLY` to ``True``. Using an ``HttpOnly`` session
  455. cookie makes it more difficult for cross-site scripting attacks to hijack user
  456. sessions.
  457. * **security.W014**: You have
  458. :class:`django.contrib.sessions.middleware.SessionMiddleware` in your
  459. :setting:`MIDDLEWARE_CLASSES`, but you have not set
  460. :setting:`SESSION_COOKIE_HTTPONLY` to ``True``. Using an ``HttpOnly`` session
  461. cookie makes it more difficult for cross-site scripting attacks to hijack user
  462. sessions.
  463. * **security.W015**: :setting:`SESSION_COOKIE_HTTPONLY` is not set to ``True``.
  464. Using an ``HttpOnly`` session cookie makes it more difficult for cross-site
  465. scripting attacks to hijack user sessions.
  466. * **security.W016**: :setting:`CSRF_COOKIE_SECURE` is not set to ``True``.
  467. Using a secure-only CSRF cookie makes it more difficult for network traffic
  468. sniffers to steal the CSRF token.
  469. * **security.W017**: :setting:`CSRF_COOKIE_HTTPONLY` is not set to ``True``.
  470. Using an ``HttpOnly`` CSRF cookie makes it more difficult for cross-site
  471. scripting attacks to steal the CSRF token.
  472. * **security.W018**: You should not have :setting:`DEBUG` set to ``True`` in
  473. deployment.
  474. * **security.W019**: You have
  475. :class:`django.middleware.clickjacking.XFrameOptionsMiddleware` in your
  476. :setting:`MIDDLEWARE_CLASSES`, but :setting:`X_FRAME_OPTIONS` is not set to
  477. ``'DENY'``. The default is ``'SAMEORIGIN'``, but unless there is a good reason
  478. for your site to serve other parts of itself in a frame, you should change
  479. it to ``'DENY'``.
  480. * **security.W020**: :setting:`ALLOWED_HOSTS` must not be empty in deployment.
  481. Sites
  482. -----
  483. The following checks are performed on any model using a
  484. :class:`~django.contrib.sites.managers.CurrentSiteManager`:
  485. * **sites.E001**: ``CurrentSiteManager`` could not find a field named
  486. ``<field name>``.
  487. * **sites.E002**: ``CurrentSiteManager`` cannot use ``<field>`` as it is not a
  488. ``ForeignKey`` or ``ManyToManyField``.
  489. Database
  490. --------
  491. MySQL
  492. ~~~~~
  493. If you're using MySQL, the following checks will be performed:
  494. * **mysql.E001**: MySQL does not allow unique ``CharField``\s to have a
  495. ``max_length`` > 255.
  496. Templates
  497. ---------
  498. The following checks verify that your :setting:`TEMPLATES` setting is correctly
  499. configured:
  500. * **templates.E001**: You have ``'APP_DIRS': True`` in your
  501. :setting:`TEMPLATES` but also specify ``'loaders'`` in ``OPTIONS``. Either
  502. remove ``APP_DIRS`` or remove the ``'loaders'`` option.