aboutsummaryrefslogtreecommitdiffstats
path: root/docs/src/templates
AgeCommit message (Collapse)Author
2013-07-25feat($sce): new $sce service for Strict Contextual Escaping.Chirayu Krishnappa
$sce is a service that provides Strict Contextual Escaping services to AngularJS. Strict Contextual Escaping -------------------------- Strict Contextual Escaping (SCE) is a mode in which AngularJS requires bindings in certain contexts to result in a value that is marked as safe to use for that context One example of such a context is binding arbitrary html controlled by the user via ng-bind-html-unsafe. We refer to these contexts as privileged or SCE contexts. As of version 1.2, Angular ships with SCE enabled by default. Note: When enabled (the default), IE8 in quirks mode is not supported. In this mode, IE8 allows one to execute arbitrary javascript by the use of the expression() syntax. Refer http://blogs.msdn.com/b/ie/archive/2008/10/16/ending-expressions.aspx to learn more about them. You can ensure your document is in standards mode and not quirks mode by adding <!doctype html> to the top of your HTML document. SCE assists in writing code in way that (a) is secure by default and (b) makes auditing for security vulnerabilities such as XSS, clickjacking, etc. a lot easier. Here's an example of a binding in a privileged context: <input ng-model="userHtml"> <div ng-bind-html-unsafe="{{userHtml}}"> Notice that ng-bind-html-unsafe is bound to {{userHtml}} controlled by the user. With SCE disabled, this application allows the user to render arbitrary HTML into the DIV. In a more realistic example, one may be rendering user comments, blog articles, etc. via bindings. (HTML is just one example of a context where rendering user controlled input creates security vulnerabilities.) For the case of HTML, you might use a library, either on the client side, or on the server side, to sanitize unsafe HTML before binding to the value and rendering it in the document. How would you ensure that every place that used these types of bindings was bound to a value that was sanitized by your library (or returned as safe for rendering by your server?) How can you ensure that you didn't accidentally delete the line that sanitized the value, or renamed some properties/fields and forgot to update the binding to the sanitized value? To be secure by default, you want to ensure that any such bindings are disallowed unless you can determine that something explicitly says it's safe to use a value for binding in that context. You can then audit your code (a simple grep would do) to ensure that this is only done for those values that you can easily tell are safe - because they were received from your server, sanitized by your library, etc. You can organize your codebase to help with this - perhaps allowing only the files in a specific directory to do this. Ensuring that the internal API exposed by that code doesn't markup arbitrary values as safe then becomes a more manageable task. In the case of AngularJS' SCE service, one uses $sce.trustAs (and shorthand methods such as $sce.trustAsHtml, etc.) to obtain values that will be accepted by SCE / privileged contexts. In privileged contexts, directives and code will bind to the result of $sce.getTrusted(context, value) rather than to the value directly. Directives use $sce.parseAs rather than $parse to watch attribute bindings, which performs the $sce.getTrusted behind the scenes on non-constant literals. As an example, ngBindHtmlUnsafe uses $sce.parseAsHtml(binding expression). Here's the actual code (slightly simplified): var ngBindHtmlUnsafeDirective = ['$sce', function($sce) { return function(scope, element, attr) { scope.$watch($sce.parseAsHtml(attr.ngBindHtmlUnsafe), function(value) { element.html(value || ''); }); }; }]; Impact on loading templates --------------------------- This applies both to the ng-include directive as well as templateUrl's specified by directives. By default, Angular only loads templates from the same domain and protocol as the application document. This is done by calling $sce.getTrustedResourceUrl on the template URL. To load templates from other domains and/or protocols, you may either either whitelist them or wrap it into a trusted value. *Please note*: The browser's Same Origin Policy and Cross-Origin Resource Sharing (CORS) policy apply in addition to this and may further restrict whether the template is successfully loaded. This means that without the right CORS policy, loading templates from a different domain won't work on all browsers. Also, loading templates from file:// URL does not work on some browsers. This feels like too much overhead for the developer? ---------------------------------------------------- It's important to remember that SCE only applies to interpolation expressions. If your expressions are constant literals, they're automatically trusted and you don't need to call $sce.trustAs on them. e.g. <div ng-html-bind-unsafe="'<b>implicitly trusted</b>'"></div> just works. Additionally, a[href] and img[src] automatically sanitize their URLs and do not pass them through $sce.getTrusted. SCE doesn't play a role here. The included $sceDelegate comes with sane defaults to allow you to load templates in ng-include from your application's domain without having to even know about SCE. It blocks loading templates from other domains or loading templates over http from an https served document. You can change these by setting your own custom whitelists and blacklists for matching such URLs. This significantly reduces the overhead. It is far easier to pay the small overhead and have an application that's secure and can be audited to verify that with much more ease than bolting security onto an application later.
2013-07-24docs(minErr): Build minErr doc siteKen Sheedlo
2013-07-23docs(index): add seed app link to menu itemRichard John
2013-07-18chore(ngdocs): fix improve button overlapMatias Niemelä
2013-07-15chore(ngdocs): remove autofocus for the filtering searchMatias Niemelä
2013-07-12chore(ngdoc): wrap all pages inside of a container tag for easy stylingMatias Niemelä
2013-07-12style(ngdocs): fix minor CSS issuesAlex Olshansky
2013-07-11feat(ngDocs): add links to source for APIJulien Bouquillon
- add tests - the link points to the gruntUtil.getVersion().number tree on github
2013-07-09fix(ngdocs): merge duplicate css class attributesAlex Olshansky
2013-06-21fix(docs): set ng-app for editing with plunkerChirayu Krishnappa
Closes #3011
2013-06-19feat(jqLite): switch bind/unbind to more recent jQuery on/offMichał Gołębiowski
jQuery switched to a completely new event binding implementation as of 1.7.0, centering around on/off methods instead of previous bind/unbind. This patch makes jqLite match this implementation while still supporting previous bind/unbind methods.
2013-06-18chore(ngdocs): change minimum search length requirementMatias Niemelä
2013-06-18chore(ngdocs): provide test code for lunr search in docsMatias Niemelä
2013-06-17feat(ngdocs): provide support for user to jump between different versions of ↵Matias Niemelä
the angularjs documentation
2013-06-17feat(ngdocs): support popover, foldouts and foldover annotationsMatias Niemelä
2013-06-17chore(ngdocs): allow user to press escape key to close docs searchMatias Niemelä
2013-06-06chore(ngdocs): expose showdown.js to docs pages and docs testing suiteMatias Niemelä
2013-06-06chore(ngdocs): setup bower as the package manager for the docs pagesMatias Niemelä
2013-06-06refactor($route): pull $route and friends into angular-route.jsIgor Minar
$route, $routeParams and ngView have been pulled from core angular.js to angular-route.js/ngRoute module. This is was done to in order keep the core focused on most commonly used functionality and allow community routers to be freely used instead of $route service. There is no need to panic, angular-route will keep on being supported by the angular team. Note: I'm intentionally not fixing tutorial links. Tutorial will need bigger changes and those should be done when we update tutorial to 1.2. BREAKING CHANGE: applications that use $route will now need to load angular-route.js file and define dependency on ngRoute module. Before: ``` ... <script src="angular.js"></script> ... var myApp = angular.module('myApp', ['someOtherModule']); ... ``` After: ``` ... <script src="angular.js"></script> <script src="angular-route.js"></script> ... var myApp = angular.module('myApp', ['ngRoute', 'someOtherModule']); ... ``` Closes #2804
2013-06-04docs(index): make menu links relativeSiddique Hameed
Before the Develop drop down menu items were hard coded with an absolute url, which meant that they did not work correctly on local or ci server builds.
2013-05-30chore(docs): add reference to the blogLucas Galfasó
Add a reference to the blog at the documentation.
2013-05-22style(docs/template): add in missing semicolonsEddie Monge
Add semicolons where they were missing in the docs section per Google code styling guide. Closes #2736
2013-05-21docs(tutorial): fix the float issue with the improve docs buttonMatias Niemelä
2013-05-21chore(package.json): kill version.yaml in favor of package.jsonIgor Minar
all versioning info is now in package.json and that's where the build scripts read it from
2013-05-20chore(ngdocs): move angular-bootstrap.js to be generated only inside the ↵Matias Niemelä
docs and remove from the build process
2013-05-16chore(docs): fix syntax error in docs.cssIgor Minar
2013-05-16feat(ngdocs): Add FullText search to replace Google search in docsMatias Niemelä
2013-05-13feat(ngdocs): external links to github, plunkr and jsfiddle available for ↵Matias Niemelä
code examples
2013-05-13chore(ngdocs): update to new version of FontAwesomeMatias Niemelä
2013-05-08chore(ngAnimate): CSS classes X-setup/X-start -> X/X-activeMatias Niemelä
BREAKING CHANGE: css classes foo-setup/foo-start become foo/foo-active The CSS transition classes have changed suffixes. To migrate rename .foo-setup {...} to .foo {...} .foo-start {...} to .foo-active {...} or for type: enter, leave, move, show, hide .foo-type-setup {...} to .foo-type {...} .foo-type-start {...} to .foo-type-active {...}
2013-05-08feat(ngdocs): add variable type hinting with colorsMatias Niemelä
2013-04-11fix(ngdocs): improve the animations used in the docs menuMatias Niemelä
2013-04-03docs: add animations into docs and directive examplesMatias Niemelä
2013-03-15feat(docs): Add Improve this doc link in each doc page, which links to the ↵Shyam Seshadri
edit mode of that file in github
2013-03-13chore(docs): add angular-mobile.js to index.htmlIgor Minar
2013-03-05chore(Grunt): switch from Rake to GruntDave Geddes
Migrates the Angular project from Rake to Grunt. Benefits: - Drops Ruby dependency - Lowers barrier to entry for contributions from JavaScript ninjas - Simplifies the Angular project setup and build process - Adopts industry-standard tools specific to JavaScript projects - Support building angular.js on Windows platform (really?!? why?!?) BREAKING CHANGE: Rake is completely replaced by Grunt. Below are the deprecated Rake tasks and their Grunt equivalents: rake --> grunt rake package --> grunt package rake init --> N/A rake clean --> grunt clean rake concat_scenario --> grunt build:scenario rake concat --> grunt build rake concat_scenario --> grunt build:scenario rake minify --> grunt minify rake version --> grunt write:version rake docs --> grunt docs rake webserver --> grunt webserver rake test --> grunt test rake test:unit --> grunt test:unit rake test:<jqlite|jquery|modules|e2e> --> grunt test:<jqlite|jquery|modules|end2end|e2e> rake test[Firefox+Safari] --> grunt test --browsers Firefox,Safari rake test[Safari] --> grunt test --browsers Safari rake autotest --> grunt autotest NOTES: * For convenience grunt test:e2e starts a webserver for you, while grunt test:end2end doesn't. Use grunt test:end2end if you already have the webserver running. * Removes duplicate entry for Describe.js in the angularScenario section of angularFiles.js * Updates docs/src/gen-docs.js to use #done intead of the deprecated #end * Uses grunt-contrib-connect instead of lib/nodeserver (removed) * Removes nodeserver.sh, travis now uses grunt webserver * Built and minified files are identical to Rake's output, with the exception of one less character for git revisions (using --short) and a couple minor whitespace differences Closes #199
2012-12-11feat(docs): Add angularjs tag to plunks and make privateggoodman
This is a minor edit to allow Plunks created by way of the docs.angularjs.org site to be appropriately tagged as `angularjs`. Also, make these generated Plunks private by default.
2012-11-29fix(docs): add missing </div> tag to sourceEdit directive templateJohannes Hansen
2012-11-28docs(menu): fix the navbar drop down linksIgor Minar
2012-11-11chore(docs): fix docs-scenario.htmlIgor Minar
2012-11-11chore(docs): remove obsolete gae filesIgor Minar
2012-10-31fix(docs): correctly generate filenames for plunkr/fiddleIgor Minar
previously examples like $http where broken because we would strip part of the filename (http-hello.html -> http) we really want to strip only the id suffix that we append to disambiguate common filenames (like index.html) which appear in many examples.
2012-10-31feat(docs): add plunkr supportShyam Seshadri
Add option to edit source in Angular Docs in Plunkr in addition to JsFiddle
2012-10-18docs(tutorial): replace JsTD with Testacular + drop snapshotsIgor Minar
JsTD references have been replaced with Testacular stuff. snapshots are PITA to maintain so I'm dropping them, everyone loves the Git version anyway.
2012-10-05fix(doc): disable directory listing in docs.angularjs.orgMisko Hevery
2012-09-17docs: load angular from CDN only on productionVojta Jina
So that when running the docs locally, eg. during e2e testing, we use the latest build version of angular, rather than the stable one from CDN. This fixes e2e tests running with Testacular.
2012-09-06fix(*): name all anonymous watch functions in AngularShyam Seshadri
This will allow us to see function names in Batarang and debugger. Closes #1119
2012-09-04fix(docs): broken url to angular-bootstrapMisko Hevery
2012-08-30docs(tutorial): correct typos and clarify a few sectionsFernando Correia
2012-08-30chore(docs): ask GAE to serve docs-keywords.jsIgor Minar