##########################################################################################

       JILS-27: Email address obfuscation

##########################################################################################


Issue Type: New Feature 
-----------------------------------------------------------------------------------------

Issue Information
====================

Priority: Major					Status:      Closed
Resolution:  Done (2016-04-29 15:03:33)
Project: Jira Issue Listing Script (JILS)


Reported By: btasker					
Assigned To: btasker


Affected Versions:		
	- 0.01b  			


Targeted for fix in version: 
	- 0.01b


Time Estimate: 0 minutes
Time Logged:   0 minutes


-----------------------------------------------------------------------------------------

Issue Description
==================

From time to time, an issue description (or comment) may include an email address. These
need to be obfuscated in one of two ways (depending on the value of a config setting)

- Obfuscated in markup but readable by a human
- Replaced with a placeholder to indicate it's an email address, but address removed from
public view.

-----------------------------------------------------------------------------------------

Activity
==========

	
-----------------------------------------------------------------------------------------
2014-11-13 01:57:12              
-----------------------------------------------------------------------------------------

btasker changed status from 'Open' to 'In Progress'
	
-----------------------------------------------------------------------------------------
2014-11-13 01:57:26              git
-----------------------------------------------------------------------------------------


-- BEGIN QUOTE --


Repo: Jira-Issue-Listing
Commit: 8c2dbe6655d616bcb1d15587265caafe65ca5ff7
Author: B Tasker <github@<Domain Hidden>>

Date: Thu Nov 13 01:56:57 2014 +0000
Commit Message: Basic email obfuscation implemented. See JILS-27



Modified (-)(+)
-------
utils.class.php



-- END QUOTE --

*Webhook User-Agent*


-- BEGIN SNIPPET --

GitHub-Hookshot/ae0346d
 -- END SNIPPET --

https://github.com/bentasker/Jira-Issue-Listing/commit/8c2dbe6655d616bcb1d15587265caafe65ca5ff7


	
-----------------------------------------------------------------------------------------
2014-11-13 02:00:24              btasker
-----------------------------------------------------------------------------------------

Have implemented a regex and callback function to perform obfuscation. At the moment
there's no option to adjust it's behaviour, but the basic functionality seems to work OK
	
-----------------------------------------------------------------------------------------
2014-11-13 02:09:26              git
-----------------------------------------------------------------------------------------


-- BEGIN QUOTE --


Repo: Jira-Issue-Listing
Commit: 234dfa3424f3d4a6311bcf06a56a82560f46818d
Author: B Tasker <github@<Domain Hidden>>

Date: Thu Nov 13 02:08:52 2014 +0000
Commit Message: Added ability to control obfuscation level. See JILS-27



Modified (-)(+)
-------
config.php
utils.class.php



-- END QUOTE --

*Webhook User-Agent*


-- BEGIN SNIPPET --

GitHub-Hookshot/ae0346d
 -- END SNIPPET --

https://github.com/bentasker/Jira-Issue-Listing/commit/234dfa3424f3d4a6311bcf06a56a82560f46818d


	
-----------------------------------------------------------------------------------------
2014-11-13 02:12:17              btasker
-----------------------------------------------------------------------------------------

Have now implemented the ability to set the obfuscation level, within the config file one
of the following can be set for _emailObfs_ 

- none
- part
- full
- bot

_Note: not case sensitive_

*None*
Does what it says on the tin, leaves the email addresses along


*Part*
Removes the domain half of any email addresses, so it becomes _user@<Domain Hidden>_


*Full*
Strips email addresses completely, replacing them with the string _<Email Hidden>_


*Bot*
Uses javascript to obfuscate addresses within the markup, but once the JS has processed a
human readable version of email addresses will be visible. This is the default value.
	
-----------------------------------------------------------------------------------------
2014-11-13 02:13:49              btasker
-----------------------------------------------------------------------------------------

Would quite like to add the ability to set a level by client (much like can be done for
project filters - internal uses would be fine with obfuscation turned off completely,
whilst a more stringent version might be wanted on anything displayed publicly)
	
-----------------------------------------------------------------------------------------
2014-11-13 02:21:17              btasker
-----------------------------------------------------------------------------------------

New config option created - _IPemailObfs_

Works the same way as _emailObfs_ but is an array allowing the default setting to be
overridden on a per-IP basis. 
	
-----------------------------------------------------------------------------------------
2014-11-13 02:21:26              git
-----------------------------------------------------------------------------------------


-- BEGIN QUOTE --


Repo: Jira-Issue-Listing
Commit: f41b57dee38b18d95d59446c87bdb83a489b39a4
Author: B Tasker <github@<Domain Hidden>>

Date: Thu Nov 13 02:19:19 2014 +0000
Commit Message: Implemented ability to override obfuscation on a per IP basis. See
JILS-27



Modified (-)(+)
-------
config.php
utils.class.php



-- END QUOTE --

*Webhook User-Agent*


-- BEGIN SNIPPET --

GitHub-Hookshot/ae0346d
 -- END SNIPPET --

https://github.com/bentasker/Jira-Issue-Listing/commit/f41b57dee38b18d95d59446c87bdb83a489b39a4


	
-----------------------------------------------------------------------------------------
2014-11-13 02:21:53              
-----------------------------------------------------------------------------------------

btasker changed status from 'In Progress' to 'Resolved'
	
-----------------------------------------------------------------------------------------
2014-11-13 02:21:53              
-----------------------------------------------------------------------------------------

btasker added 'Done' to resolution
	
-----------------------------------------------------------------------------------------
2014-11-13 02:21:58              
-----------------------------------------------------------------------------------------

btasker changed status from 'Resolved' to 'Closed'
	
-----------------------------------------------------------------------------------------
2014-11-13 03:01:26              mail handler
-----------------------------------------------------------------------------------------


-- BEGIN SNIPPET --

-------------------------
From: Ben Tasker <ben@<Domain Hidden>>
To: "Ben Tasker (JIRA)" <jiraacct@<Domain Hidden>>
Date: Thu, 13 Nov 2014 02:57:47 +0000
Subject: JILS-27
-------------------------

 -- END SNIPPET --

A basic mail-envelope is now being written into emails received by JIRA,
and the Issue Listing Script is correctly obfuscating the displayed
addresses on a per client basis

-- 
Ben Tasker
http://www.bentasker.co.uk

One Server to rule them all,
One Ping to Find Them,
One LAN to bring them all,
And in the darknet BIND them.

- The Tolkien Ring Network

01001001 01100110 00100000 01111001 01101111 01110101 00100000 01100011
01100001 01101110 00100000 01110010 01100101 01100001 01100100 00100000
01110100 01101000 01101001 01110011 00100000 01111001 01101111 01110101
00100000 01100001 01110010 01100101 00100000 01100001 01110011 00100000
01110011 01100001 01100100 00100000 01100001 01110011 00100000 01001001
00100000 01100001 01101101

Command line Russian Roulette: [ $[ $RANDOM % 6 ] == 0 ] && rm -rf / ||
echo *Click*

	
-----------------------------------------------------------------------------------------
2016-04-29 14:54:06              btasker
-----------------------------------------------------------------------------------------

Re-opening to assign to a version
	
-----------------------------------------------------------------------------------------
2016-04-29 14:54:06              
-----------------------------------------------------------------------------------------

btasker removed 'Done' from resolution
	
-----------------------------------------------------------------------------------------
2016-04-29 14:54:06              
-----------------------------------------------------------------------------------------

btasker changed status from 'Closed' to 'Reopened'
	
-----------------------------------------------------------------------------------------
2016-04-29 14:55:26              btasker
-----------------------------------------------------------------------------------------

Assigning to v0.01b
	
-----------------------------------------------------------------------------------------
2016-04-29 14:55:27              
-----------------------------------------------------------------------------------------

btasker added '0.01b' to Version
	
-----------------------------------------------------------------------------------------
2016-04-29 14:55:27              
-----------------------------------------------------------------------------------------

btasker added '0.01b' to Fix Version
	
-----------------------------------------------------------------------------------------
2016-04-29 15:03:33              btasker
-----------------------------------------------------------------------------------------

Re-Closing
	
-----------------------------------------------------------------------------------------
2016-04-29 15:03:33              
-----------------------------------------------------------------------------------------

btasker changed status from 'Reopened' to 'Resolved'
	
-----------------------------------------------------------------------------------------
2016-04-29 15:03:33              
-----------------------------------------------------------------------------------------

btasker added 'Done' to resolution
	
-----------------------------------------------------------------------------------------
2016-04-29 15:03:37              
-----------------------------------------------------------------------------------------

btasker changed status from 'Resolved' to 'Closed'