checks.txt 28 KB

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