Lyla Captcha


About LylaCaptcha	Download	FAQs	Known Issues	Contact

1.	What is a Captcha?
2.	What does Captcha stand for?
3.	What applications do Captcha have?
4.	Are Captchas accessible?
5.	Why did you name it Lyla?
6.	How is LylaCaptcha licensed?
7.	Who created and maintains LylaCaptcha?
8.	How do I install Lyla Captcha?
9.	How do I configure Lyla Captcha?
10.	How do I know which fonts to use?
11.	How do I init and setup the Captcha service?
12.	How do I setup the Captcha service with ColdSpring?
13.	What are the public methods?
14.	How do I use a Hash Reference?
15.	How do I serve a Captcha using <cfcontent>?
16.	How can I test LylaCaptcha?
17.	What does the default rendering look like?
18.	Is LylaCaptcha safe for use on non-sticky session server clusters?
19.	What file formats can LylaCaptcha create?
20.	How many KBs are the files that Lyla creates?
21.	What about your plans for future versions of LylaCaptcha?
22.	Who uses LylaCaptcha?
23.	Who does the author want to thank?
24.	How can I show my appreciate to the author or supporting the author's Shameless Begging?

What is a Captcha?

A Captcha is a type of challenge-response test used to determine whether or not the user is human. A common type of captcha requires that the user type the letters of a distorted, sometimes with the addition of obscured sequence of letters or digits that appears in an image. A Captcha can also be administered in the form of question in which the user provides the correct answer.

Config Name	Default	Type	Accepted Values	Description
outputDirectory	img/	string	valid path or mapping	Directory path to store generated Captchas
outputDirectoryIsRelative	true	boolean	True False	Switch is the output directory is relative [Uses ExpandPath()]
saltType	auto	string	auto defined	The salt type to use. Use ï¿½autoï¿½ if the Captcha is being deployed to non-sticky session servers.
saltValue	[null]	string	must be at least 10 characters long for security	The salt value. Use if the saltType is ï¿½Autoï¿½.
jpegQuality	0.90	numeric	decimal between 0-1.00	The quality setting for JPEG.
jpegUseBaseline	true	Boolean	True False	Switch for JPEG baseline.
useAntiAlias	true	Boolean	True False	Switch for JPEG anti-aliasing
randStrType	alpha	string	alpha alphaLCase alphaUCase alphaNum alphaNumLCase secure (alphaNum + special)	Type of random string to generate for the Captcha unless the text is passed into the service
randStrLen	6	numeric	whole number only	*Average number of characters o use in the Captcha (varies -1 to +1 of the value)
width	250	numeric	whole number only	Desired width
height	75	numeric	whole number only	Desired height
fontsize	30	numeric	whole number only	*Average font size to use in the Captcha
leftOffset	20	numeric	whole number only	*Average number of pixels to offset the first character
shearXRange	25	numeric	whole number only	*Average X axis shear range
shearYRange	25	numeric	whole number only	*Average Y axis shear range
fontColor	light	string	light medium dark lightGray mediumGray darkGray	The color range to use for the Captcha characters
backgroundColor	dark	string	light medium dark lightGray mediumGray darkGray	The color range to use for the background
useGradientBackground	true	Boolean	True False	Switch for gradient type background
backgroundColorUseCyclic	true	Boolean	True False	Switch for wavy/oscillating background.
useOvals	true	Boolean	True False	Switch for ovals in the background
ovalColor	medium	string	light medium dark lightGray mediumGray darkGray	The color range to use for ovals
ovalUseTransparency	true	Boolean	True False	Switch for transparency (alpha channel) when creating ovals
minOvals	15	numeric	whole number only	Minimum number of ovals
maxOvals	20	numeric	whole number only	Maximum number of ovals
useBackgroundLines	true	Boolean	True False	Switch for background lines
backgroundLineColor	medium	string	light medium dark lightGray mediumGray darkGray	The color range to use for background lines.
backgroundLineUseTransparency	true	Boolean	True False	Switch for transparency (alpha channel) when creating background lines
backgroundMinLines	5	numeric	whole number only	Minimum number of background lines
backgroundMaxLines	10	numeric	whole number only	Maximum number of background lines
useForegroundLines	true	Boolean	True False	Switch for foreground lines
foregroundlineColor	light	string	light medium dark lightGray mediumGray darkGray	The Color range to use for foreground lines.
foregroundLineUseTransparency	true	Boolean	True False	Switch for transparency (alpha channel) when creating foreground lines
foregroundMinLines	5	numeric	whole number only	Minimum number of foreground lines
foregroundMaxLines	10	numeric	whole number only	Maximum number of foreground lines

Method Name	Type	Return Type	Results	Description
createHashReference()	general	struct	type = hash text = random string hash = hash reference width = width of image height = height of image	Creates a hash reference in the service. Does not actually create a Captcha, but creates a reference so a Captcha can be created in a future request.
createCaptchaFromHashReference()	general	struct	type = hash text = random string hash = hash reference width = width of image height = height of image If argument type is ï¿½fileï¿½: fileLocation (combination of both fileDirectory and fileName) fileDirectory fileName If argument type is ï¿½streamï¿½: stream (Java byte array of image to use with cfcontent)	Creates a captcha to the desired from a hash reference.
createCaptcha()	general	struct	type = hash text = random string hash = hash reference width = width of image height = height of image If argument type is ï¿½fileï¿½: fileLocation (combination of both fileDirectory and fileName) fileDirectory fileName If argument type is ï¿½streamï¿½: stream (Java byte array of image to use with cfcontent)	Creates a captcha to the desired stream.
validateCaptcha()	general	boolean	True	Validates a captcha by hash and user response text.
getAvailableFontNames()	utility	array		Returns an array of all available system fonts. This is useful when deciding on fonts to use for Captcha configuration.