User Guide Cancel

cflogin

Last updated on | Also Applies to ColdFusion

ColdFusion User Guide
Introduction to ColdFusion
Cloud Services in ColdFusion
Install ColdFusion
Use ColdFusion
Performance Monitoring Toolset
Adobe ColdFusion Builder extension for Visual Studio Code
Use ColdFusion Builder
Coldfusion API Manager
Configure and administer ColdFusion
ColdFusion functions
ColdFusion Tags
1. ColdFusion tags by category
2. Tags a-b
3. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
4. Tags f
5. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
6. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
7. Tags j-l
8. Tags m-o
9. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
10. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
11. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
12. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Develop ColdFusion applications
1. Introducing ColdFusion
2. Changes in ColdFusion
3. Introduction to application development
4. The CFML programming language
5. Building blocks of ColdFusion applications
6. Develop CFML applications
7. Develop mobile applications
8. Access and use data
9. ColdFusion ORM
10. ColdFusion and HTML5
11. Flex and AIR integration in ColdFusion
12. Request and present information
13. Office file interoperability
14. ColdFusion portlets
15. Work with documents, charts, and reports
16. Use web elements and external objects
17. Use external resources

Description

A container for user login and authentication code. ColdFusion runs the code in this tag if a user is not already logged in. You put code in the tag that authenticates the user and identifies the user with a set of roles. Used with cfloginuser tag.

Syntax

<cflogin 
applicationToken = "token" 
cookieDomain = "domain" 
idletimeout = "value"
allowconcurrent = "true|false"
usebasicauth = "true|false"> 
... 
<cfloginuser 
name = "name" 
password = "password" 
roles = "roles"> 
</cflogin>

History

ColdFusion 11: Added 2 new attributes allowconcurrent and usebasicauth.

ColdFusion 8: The applicationtoken attribute lets you specify a unique application identifier for each application, or the same value for multiple applications.ColdFusion MX 6.1: Changed behavior: the cflogin variable exists when ColdFusion receives a request with NTLM or Digest (HTTP Negotiated header) authentication information.ColdFusion MX: Added this tag.

Attributes

Attribute	Req/Opt	Default	Description
applicationtoken	Optional	The current application name	The login that applies to the application. To let users log in to only one application, specify a unique value for that application. To let users log in to multiple applications, specify the same value for those applications. If you do not set a value for the applicationtoken attribute, the default value is CFAUTHORIZATION_applicationname.
cookiedomain	Optional		Domain of the cookie that is used to mark a user as logged in. Use this attribute to enable a user login cookie to work with multiple clustered servers in the same domain.
idletimeout	Optional	1800	Time interval, in seconds, after which ColdFusion logs off the user.
allowconcurrent	Optional	true	If concurrent login sessions should be allowed.
usebasicauth	Optional	true	If basic authentication should be used to validate the login.

Usage

The body of this tag executes only if there is no logged-in user. When using application-based security, you put code in the body of the cflogin tag to check the user-provided ID and password against a data source, LDAP directory, or other repository of login identification. The body must include a cfloginuser tag to establish the authenticated user's identity in ColdFusion.
You control the data source and are responsible for coding the SQL within the cflogin tag; make sure that the associated database has user, password, and role information.
The cflogin tag has a built-in cflogin structure that contains two variables, cflogin.name and cflogin.password, if the page is executing in response to any of the following:

Submission of a form that contains input fields with the names j_username and j_password.
A request that uses HTTP Basic authentication and, therefore, includes an Authorization header with the user name and password.
A request that uses NTLM or Digest authentication. In this case, the username and password are hashed using a one-way algorithm in the Authorization header; ColdFusion gets the username from the web server and sets the cflogin.password value to the empty string.
You can use these values in the cflogin tag body to authenticate the user, and, in the cfloginuser tag, to log the user in. The structure is only available in the cflogin tag body.

Example

The following example shows a simple authentication. This code is typically in the Application.cfc onRequestStart method or in the application.cfm page.

<cflogin> 
<cfif NOT IsDefined("cflogin")> 
<cfinclude template="loginform.cfm"> 
<cfabort> 
<cfelse> 
<cfif cflogin.name eq "admin"> 
<cfset roles = "user,admin"> 
<cfelse> 
<cfset roles = "user"> 
</cfif> 
<cfloginuser name = "#cflogin.name#" password = "#cflogin.password#" 
roles = "#roles#"/> 
</cfif> 
</cflogin>

The following view-only example checks the user ID and password against a data source:

<cfquery name="qSecurity" 
datasource="UserRolesDb"> 
SELECT Roles FROM SecurityRoles 
WHERE username=<cfqueryparam value='#cflogin.name#' CFSQLTYPE="CF_SQL_VARCHAR" 
AND password=<cfqueryparam value='#cflogin.password#' CFSQLTYPE='CF_SQL_VARCHAR' 
</cfquery> 

<cfif qSecurity.recordcount gt 0> 
<cfloginuser name = "#cflogin.name#" 
password = "#cflogin.password#" 
roles = "#trim(qSecurity.Roles)#" > 
</cfif>

cflogin

Description

Category

Syntax

See also

History

Attributes

Usage

Example

Ask the Community

Contact Us