001/*
002 * (C) Copyright 2006-2010 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Florent Guillaume
018 */
019package org.nuxeo.ecm.platform.htmlsanitizer;
020
021import org.nuxeo.ecm.core.api.DocumentModel;
022
023/**
024 * Service that sanitizes some HTML fields to remove potential cross-site scripting attacks in them.
025 */
026public interface HtmlSanitizerService {
027
028    /**
029     * Sanitizes a document's fields, depending on the service configuration.
030     */
031    void sanitizeDocument(DocumentModel doc);
032
033    /**
034     * Sanitizes a string.
035     *
036     * @param html the string to sanitize
037     * @param info additional info logged when something is sanitized
038     * @return the sanitized string
039     */
040    String sanitizeString(String html, String info);
041
042}